TACL Reference Manual

Built-In Functions and Variables
HP NonStop TACL Reference Manual—429513-018
9-388
#SSPUT Built-In Function
•
Adding a token to the buffer with #SSPUT does not affect the current position for
subsequent calls to #SSGET or #SSGETV.
Header Tokens and Special Operations for #SSPUT and #SSPUTV
Header tokens for #SSPUT and #SSPUTV include tokens to enable or disable
checksum protection, specify the maximum-response value, restore the current
position to an earlier value, and specify the server RVU. These tokens are present in
the buffer, but have special characteristics that distinguish them from other tokens.
Special operations for #SSPUT and #SSPUTV include clearing the last-error
information, flushing data from the buffer, deleting tokens, and initializing the current
position. These tokens are not in the buffer, but simply serve as parameters to
#SSPUT and #SSPUTV.
Table 9-15 lists the header tokens you can supply to #SSPUT(V) to set or change the
corresponding values, and also the special tokens you can pass to #SSPUT and
#SSPUTV to perform special operations.
For some of these tokens, when you pass them to #SSPUT or #SSPUTV in the token-
code parameter, special considerations apply to other parameters involved.
ZSPI^TKN^CHECKSUM. Use this token code with a nonzero token-value to
enable checksum protection of the data portion of the buffer; use a zero token-value
to disable it (the header is always protected by a checksum).
Table 9-15. #SSPUT(V) Header Tokens and Special Operations
Token Code Type Item retrieved
ZSPI^TKN^CHECKSUM INT Enables or disables buffer checksum
protection
ZSPI^TKN^CLEARERR none Clears last-error information to zero
ZSPI^TKN^DATA^FLUSH none Flushes all data in message buffer at or
after current position
ZSPI^TKN^DELETE INT2 Deletes specified token code from buffer
ZSPI^TKN^INITIAL^POSITION INT Resets position to start of buffer or start of
current list
ZSPI^TKN^MAXRESP INT Sets maximum-responses header token
ZSPI^TKN^POSITION BYTE:8 Restores position saved earlier with
#SSGET or #SSGETV
ZSPI^TKN^RESET^BUFFER UINT Resets maximum buffer length, clear last-
error information, and reset position to
start in an SPI buffer received from
another process
ZSPI^TKN^SERVER^VERSION UINT Sets server-RVU header token
ZSPI^TKN^CHECKSUM INT Enables or disables buffer checksum
protection