SPI Programming Manual (G06.24+, H06.03+, J06.03+)
SPI Programming in TACL
SPI Programming Manual—427506-006
8-20
#SSGET
SSID ssid
gives a subsystem ID (of type SSID) that qualifies the token code. If ssid is
omitted or equal to zero (0.0.0), it defaults to the subsystem ID of the current
list, or if the current position is not in a list, then to the subsystem ID specified
in the SPI message header. The version field of this parameter is not used
when searching the buffer.
buffer-var
is the name of the SPI message-buffer variable from which information is to be
extracted.
get-op
is one of:
token-code
directs #SSGET to return the token value or values associated with the
specified token code. (For a token map, or a token code of type
ZSPI^TYP^STRUCT, use #SSGETV.)
If
token-code is a token that marks the beginning of a list
(ZSPI^TKN^DATALIST, ZSPI^TKN^ERRLIST, or ZSPI^TKN^LIST), #SSGET
selects the list so that subsequent calls can retrieve tokens within the list. If
token-code is ZSPI^TKN^ENDLIST, #SSGET deselects (pops out of) the list.
For
token-code, you can supply one of the header tokens in Table 8-2 on
page 8-13. You can also supply the token ZSPI^TKN^DEFAULT^SSID to
obtain the default subsystem ID at the current position (see Special Operations
for #SSPUT and #SSPUTV on page 8-13).
ZSPI^TKN^COUNT c-token-id
directs #SSGET to return the total number of occurrences of the token
specified by the token code or token map
c-token-id, starting at index. If
index is not supplied, counting starts from the current position. To count all
occurrences in the current list, specify an
index of 1.
If
c-token-id is either omitted or equal to ZSPI^VAL^NULL^TOKENCODE
and
index is either omitted or zero, then #SSGET counts occurrences of the
current token beginning with the current occurrence.
ZSPI^TKN^LEN l-token-id
directs #SSGET to return the byte length of the token specified by the token
code or token map
l-token-id. The value returned is the size of the buffer
needed to contain the specified occurrence of the token value. For variable-
length token values, this includes the two bytes required for the length word:
the byte length returned is
token-value[0] + 2.