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

The SPI Procedures
SPI Programming Manual—427506-006
3-9
Special Operations With SSPUT and SSPUTTKN
resets the maximum buffer length in the SPI message header, and subsequent SPI
calls for that buffer fails with ZSPI-ERR-INVBUF.
ZSPI-TKN-CHECKSUM: Set Checksum Flag
With this token code, a nonzero token-value enables checksum protection of the
buffer; a zero
token-value disables it.
ZSPI-TKN-CLEARERR: Clear Last SPI Error
Use this token code to clear the last-error information to zero. If supplied, the token-
value parameter is ignored.
You might use this operation before issuing a series of SSPUT and SSGET calls that
are followed by a check of the last error. You need this operation only if you use
SSGET to check the header token ZSPI-TKN-LASTERR.
ZSPI-TKN-DATA-FLUSH: Clear Buffer From Current Position
Use this token code to flush all information in the message buffer located at and
following the current-token pointer. If supplied,
token-value is ignored. The ZSPI-
TKN-DATA-FLUSH 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-DELETE: Delete a Token or List
Use this token code to delete a particular token or a list from the buffer. The call syntax
is:
token-code
is the token code of the token to be deleted. If token-code is ZSPI-TKN-LIST, -
DATALIST, -ERRLIST, or -SEGLIST, the entire list is deleted.
index
INT:value
if greater than zero, specifies an absolute index for
token-id, starting from the
beginning of the buffer or current list. An
index of one deletes the first occurrence
of that token code, an
index of two deletes the second occurrence, and so on.
SSPUT ( buffer
SSPUTTKN , ZSPI-TKN-DELETE
, token-code, ! i
, index, ! i
, [ ssid ] ) ! i