SPI Programming Manual (G06.24+, H06.03+, J06.03+)

The SPI Procedures
SPI Programming Manual—427506-006
3-10
Special Operations With SSPUT and SSPUTTKN
if zero or not supplied, deletes the next occurrence of the token code at or
following the current-token pointer in the buffer.
if less than zero, returns an error.
ssid
can be included to qualify token-code.
The ZSPI-TKN-DELETE operation does not update the header token ZSPI-TKN-MAX-
FIELD-VERSION. As a result, following this operation, that token can indicate a
version higher than the version of any field remaining in the buffer.
ZSPI-TKN-INITIAL-POSITION: Reset Current -Token and
Next-Token Pointers
This special operation resets the current position and next position to either the initial
position in the buffer (the position just prior to the first token that is not a header token)
or the initial position in the currently selected list (the position just prior to the list
token). If
token-value is ZSPI-VAL-INITIAL-BUFFER (0), 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-MAX-FIELD-VERSION: Increase Maximum Version
of Structure Fields
Use this token code to increase the maximum field version of the buffer. If the value
specified is greater than the current value, the specified value is used. Otherwise, the
current value is retained.
ZSPI-TKN-MAXRESP: Set Maximum Responses
Use this token code to set the header token that specifies the maximum number of
response records 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 positive
token-value specifies up to that number of response records, each enclosed in a
list. A
token-value of -1 specifies as many response records as fit, each enclosed in
a list.
ZSPI-TKN-POSITION: Set Current-Token Pointer
Use this token code to restore a position previously saved using SSGET or
SSGETTKN. The
token-value is a four-word position descriptor. For this operation
to be valid, the contents of the buffer prior to the previously saved position must not
have been modified by ZSPI-TKN-DELETE, ZSPI-TKN-DATAFLUSH, or SSMOVE
operations. Otherwise, this operation can corrupt the buffer and cause later operations
to give indeterminate results. If
token-value is all zeros or not supplied, this