TACL Reference Manual

Built-In Functions and Variables
HP NonStop TACL Reference Manual—429513-018
9-389
#SSPUT Built-In Function
ZSPI^TKN^CLEARERR. Use this token code to clear the last-error information to
zero. When using this token code, you must omit token-value and the COUNT
option. You could use this operation before issuing a series of #SSGET(V) or
#SSPUT(V) calls that are followed by a check of the last error. You need this operation
only if you use #SSPUT or #SSPUTV to check the header token
ZSPI^TKN^LASTERR.
ZSPI^TKN^DATA^FLUSH. Use this token code to flush all information in the
message buffer located at or after the current position. You must omit token-value
and the COUNT option.
ZSPI^TKN^DELETE. Use this token code to delete a token code from the buffer.
Specify the token code to be deleted in token-value. You can use the SSID option,
if needed, to qualify token-code. If token-code is a token that begins a list, the
operation deletes the entire list.
You must use the COUNT option; #SSPUT and #SSPUTV interpret count as the index
value of the token code to be deleted.
ZSPI^TKN^INITIAL^POSITION. Use this token code to reset the current position as
specified by token-value. If token-value is ZSPI^VAL^INITIAL^BUFFER (zero),
the position is reset to the beginning of the buffer. If token-value is
ZSPI^VAL^INITIAL^LIST (-1), the position is reset to the beginning of the current list.
ZSPI^TKN^MAXRESP. Use this token code to set the header field that specifies the
maximum number of responses to return in a single reply message. A token-value
of zero (the default) specifies one response record per reply, not enclosed in a list. Any
token-value greater than zero specifies up to that number of response records,
each enclosed in a list. A token-value of -1 specifies as many response records as
can fit, each enclosed in a list.
You must omit the COUNT option.
ZSPI^TKN^POSITION. Use this token code to restore a position previously saved
using #SSGET or #SSGETV. The token value is a position descriptor (either eight
separate byte values for #SSPUT or an eight-byte STRUCT for #SSPUTV). The buffer
contents that precede the previously saved position must not have been modified by
ZSPI^TKN^DELETE, ZSPI^TKN^DATAFLUSH, or #SSMOVE operations, or this
operation could corrupt the buffer and cause later operations to give unpredictable
results. If token-value is zero or omitted, this operation set
s the current position to
the start of the buffer.
ZSPI^TKN^RESET^BUFFER. Use this token before extracting tokens from an SPI
buffer received (in either a request or a reply) from another process. This operation
performs three actions:
•
It resets the maximum buffer length to the value given in token-value.
Note. The ZSPI^TKN^DATA^FLUSH and ZSPI^TKN^DELETE operations do not update the
header token ZSPI^TKN^MAX^FIELD^VERSION, which can cause that field to indicate a
higher version level than is actually contained in the buffer.