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

SPI Programming in TACL
SPI Programming Manual—427506-006
8-12
#SSPUT
SSID ssid
is a subsystem ID that qualifies the token code. If ssid is zero (0.0.0) or if you
do not supply this option, the default applies. If #SSPUT is currently adding
tokens to a list,
ssid defaults to the subsystem ID of that list; otherwise, ssid
defaults to the subsystem ID in the SPI message header (ZSPI^TKN^SSID).
buffer-var
is the name of the SPI message-buffer variable into which tokens are to be placed.
token-code
either identifies the token being supplied or denotes a special operation. The
special operations are described further in Special Operations for #SSPUT and
#SSPUTV on page 8-13. (To specify a token map, or a token code of type
ZSPI^TYP^STRUCT, use #SSPUTV.)
token-value
if present, is the value of the token. Its data representation is determined by the
token-type field of the
token-code.
Expansion
#SSPUT expands to a numeric status code indicating the outcome of the operation.
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 List 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.
Considerations
•
The token-value parameter is optional if the token length specified by token-
code is zero (for instance, if token-code is ZSPI^TKN^DATALIST,
ZSPI^TKN^ERRLIST, ZSPI^TKN^LIST, ZSPI^TKN^ENDLIST, or
ZEMS^TKN^SUBJECT^MARK). Otherwise, the
token-value parameter is
required.