SPI Reference Summary

SPI Procedures and Functions
SPI Reference Summary—427507-006
2-5
SSGET and SSGETKN Procedures
Special Operations Tokens for SSGET and SSGETTKN
The call syntax follows the token code description.
ZSPI-TKN-ADDR
Use this token code to get the extended address of a specific token value.
This operation returns in token-address, INT .EXT:ref:2, the 32-bit extended
address of the value specified by token-id and index. For variable-length token
values, this is the address of the length word at the start of the token value.
Token Type Operation
ZSPI-TKN-ADDR TOKENCODE Retrieves address of token
ZSPI-TKN-BUFLEN UINT Retrieves buffer length
ZSPI-TKN-CHECKSUM BOOLEAN Retrieves checksum flag
ZSPI-TKN-COMMAND ENUM Retrieves command number
ZSPI-TKN-COUNT TOKENCODE Counts occurrences of token
ZSPI-TKN-DEFAULT-SSID SSID Retrieves SSID at current position
ZSPI-TKN-HDRTYPE UINT Retrieves message header type
ZSPI-TKN-LASTERR ENUM Retrieves last procedure call error
ZSPI-TKN-LASTERRCODE TOKENCODE Retrieves code of token in last
error
ZSPI-TKN-LASTPOSITION POSITION Retrieves position of last put token
ZSPI-TKN-LEN TOKENCODE Retrieves length of token value
ZSPI-TKN-MAX-FIELD-VERSION UINT Retrieves maximum field version
ZSPI-TKN-MAXRESP INT Retrieves maximum responses
value
ZSPI-TKN-NEXTCODE TOKENCODE Retrieves next different token code
ZSPI-TKN-NEXTTOKEN TOKENCODE Retrieves next token code
ZSPI-TKN-OBJECT-TYPE ENUM Retrieves object type
ZSPI-TKN-OFFSET TOKENCODE Gets byte offset of token value
ZSPI-TKN-POSITION POSITION Retrieves current-token pointer
ZSPI-TKN-SERVER-VERSION UINT Retrieves server version
ZSPI-TKN-SSID SSID Retrieves SSID of message
ZSPI-TKN-USEDLEN UINT Retrieves used buffer length
SSGET ( buffer
SSGETTKN , ZSPI-TKN-ADDR
, [ token-id ] ! i
, [ index ] ! i
, [ token-address ] ! o
, [ ssid ] ) ! i