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

The SPI Procedures
SPI Programming Manual—427506-006
3-8
Special Operations With SSPUT and SSPUTTKN
is a subsystem ID that qualifies the token code. If ssid is not supplied or is equal
to zero ( 6*[0] ), the default applies. If SSPUT is currently adding tokens to a list,
ssid defaults to the subsystem ID of that list; otherwise, ssid defaults to the
subsystem ID in the SPI message header (ZSPI-TKN-SSID).
Special Operations With SSPUT and SSPUTTKN
Table 3-1 lists the special tokens your programs can supply to SSPUT and
SSPUTTKN to set or change the values of header tokens and perform other special
operations. The token type listed in the table indicates the type of the
token-value
parameter, which is always an input parameter.
Each operation is described following the table. For some operations, the procedure
parameters differ in type and meaning from those indicated in the main SSPUT(TKN)
syntax description. When this is true, the modified syntax and semantics are given or
the differences are described.
ZSPI-TKN-BUFLEN: Modify Buffer Length
Use this token code to modify the SPI buffer length. If the specified length is less than
the actual number of bytes used in the buffer, as given in the header token ZSPI-TKN-
USEDLEN, the procedure returns ZSPI-ERR-NOSPACE. However, the procedure still
Table 3-1. SSPUT(TKN) Special Operations
Token Specified in SSPUT(TKN) Call Type Effect
ZSPI-TKN-BUFLEN UINT Modify buffer length
ZSPI-TKN-CHECKSUM BOOLEAN Enable or disable buffer
checksum
ZSPI-TKN-CLEARERR SSCTL Clear last-error information to
zero
ZSPI-TKN-DATA-FLUSH SSCTL Flush tokens starting at
current position
ZSPI-TKN-DELETE TOKENCODE Delete a token from the buffer
ZSPI-TKN-INITIAL-POSITION BOOLEAN Reset position to start of
buffer or list
ZSPI-TKN-MAX-FIELD-VERSION UINT Increase maximum field
version
ZSPI-TKN-MAXRESP INT Set maximum-responses
header token
ZSPI-TKN-POSITION POSITION Restore a previously saved
position
ZSPI-TKN-RESET-BUFFER UINT Reset buffer
ZSPI-TKN-SERVER-VERSION UINT Set server-version header
token