SPI Reference Summary

SPI Procedures and Functions
SPI Reference Summary—427507-006
2-12
#SSGET and #SSGETV Built-In Functions
#SSGET and #SSGETV Built-In Functions
#SSGET and #SSGETV retrieve binary token values from a SPI buffer and convert
them to external representation (#SSGET) or put them in a STRUCT (#SSGETV).
Expansion
Status code (SPI error) = 0, -1 through -12
#SSGET [ / option [ , option ] ... / ] buffer-var get-op
#SSGETV [ / option [ , option ] ... / ] buffer-var get-op
result-var
option:
[ COUNT count ]
[ INDEX index ]
[ SSID ssid ]
buffer-var
SPI message-buffer variable from which information is to
be extracted
get-op:
{ token-code (#SSGET) or token-id (#SSGETV) }
{ ZSPI^TKN^COUNT c-token-id }
{ ZSPI^TKN^LEN l-token-id }
{ ZSPI^TKN^NEXTCODE }
{ ZSPI^TKN^NEXTTOKEN }
{ ZSPI^TKN^OFFSET o-token-id }
result-var
STRUCT to receive result; result depends on get-op
Parameter Description (page1of2)
COUNT count Gives maximum number of token values to return
INDEX index >0 = specifies position for token-code from start of buffer or
list
0 or omitted = returns next occurrence of token and resets
current position to token returned
SSID ssid Gives subsystem ID, qualifying token code
token-code (#SSGET) Returns value or values of token-code
token-id (#SSGETV) Returns value or values of token-id (token code or token
map)
ZSPI^TKN^COUNT Returns number of occurrences of c-token-id (token code
or token map), starting at index
ZSPI^TKN^LEN Returns byte length of l-token-id (token code or token
map)