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

SPI Programming in TACL
SPI Programming Manual—427506-006
8-22
#SSGET
If o-token-id is either omitted or equal to ZSPI^VAL^NULL^TOKENCODE
and
index is either omitted or zero, then #SSGET returns the length of the
current occurrence of the current token.
Expansion
#SSGET expands to a numeric status code indicating the outcome of the operation. If
the status code is 0 (no error), it is followed by a space and a space-separated list of
the relevant results in TACL’s external representation.
The status code has one of these values:
0 No error
-1 Invalid buffer format
-2 Illegal parameter value
-3 Missing parameter
-4 Illegal parameter address
-5 Buffer full
-6 Invalid checksum
-7 Internal error
-8 Token not found
-9 Illegal token code or map
-10 Invalid subsystem ID
-11 Operation not supported
-12 Insufficient stack space
For more information about nonzero status codes, see Appendix A, Errors. If the status
is 0, these results are returned following the status:
•
If you specified token-code, the number of token values returned, followed by a
space-separated list of the token values in external form. Variable-length token
values are returned in two parts—the byte length followed by the actual value—
separated by a space.
•
If you specified ZSPI^TKN^COUNT c-token-id, the total number of occurrences
of the token specified by the token code or token map
c-token-id, starting at
index.
•
If you specified ZSPI^TKN^LEN l-token-id, the length of the token specified by
the token code or token map
l-token-id.
•
If you specified ZSPI^TKN^NEXTCODE, the next token code that is different from
the current token code, followed by the subsystem ID.
•
If you specified ZSPI^TKN^NEXTTOKEN, the next token code, regardless of
whether it is different from the current token code, followed by the subsystem ID.
•
If you specified ZSPI^TKN^OFFSET o-token-id, the byte offset of the token is
specified by the token code or token map
o-token-id.