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

The SPI Procedures
SPI Programming Manual—427506-006
3-15
Special Operations With SSGET and SSGETTKN
ZSPI-TKN-ADDR: Retrieve Address of a Token Value
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 (see
Figure 2-2
on page 2-6). If token-id is either omitted or equal to ZSPI-VAL-NULL-
TOKENCODE and
index is either omitted or zero, SSGET or SSGETTKN returns the
address of the current token.
ZSPI-TKN-LASTERR ENUM Retrieve last procedure call
error
ZSPI-TKN-LASTERRCODE TOKENCODE Retrieve code of token in last
error
ZSPI-TKN-LASTPOSITION POSITION Retrieve position of last put
token
ZSPI-TKN-LEN TOKENCODE Retrieve the length of a token
value
ZSPI-TKN-MAX-FIELD-VERSION UINT Retrieve maximum field
version
ZSPI-TKN-MAXRESP INT Retrieve maximum responses
value
ZSPI-TKN-NEXTCODE TOKENCODE Retrieve the next different
token code
ZSPI-TKN-NEXTTOKEN TOKENCODE Retrieve the next token code
ZSPI-TKN-OBJECT-TYPE ENUM Retrieve object type
ZSPI-TKN-OFFSET TOKENCODE Get the byte offset of a token
value
ZSPI-TKN-POSITION POSITION Retrieve current-token pointer
ZSPI-TKN-SERVER-VERSION UINT Retrieve server version
ZSPI-TKN-SSID SSID Retrieve SSID of message
ZSPI-TKN-USEDLEN UINT Retrieve used buffer length
SSGET ( buffer
SSGETTKN , ZSPI-TKN-ADDR
, [ token-id ] ! i
, [ index ] ! i
, token-address ! o
, [ ssid ] ) ! i
Table 3-2. SSGET(TKN) Special Operations (page 2 of 2)
Token Specified in SSGET(TKN) Call Type Effect