TACL Reference Manual

Built-In Functions and Variables
HP NonStop TACL Reference Manual—429513-018
9-375
#SSGET Built-In Function
Header Tokens and Special Operation for #SSGET and #SSGETV
Table 9-14 lists the header tokens used to obtain the values of various fields of the SPI
message header. The index parameter you specify with these token codes must be 0
or 1.
Table 9-14. #SSGET(V) Header Tokens
If you specify ZSPI^TKN^LASTPOSITION or ZSPI^TKN^POSITION, the value
returned is an eight-byte position descriptor that you can later use to reset the position
with the #SSPUT or #SSPUTV special operation ZSPI^TKN^POSITION. For #SSGET,
the position descriptor is returned as a space-separated list of eight one-byte values.
For #SSGETV, the value is returned in a STRUCT consisting of eight bytes.
You can also use the special token code ZSPI^TKN^DEFAULT^SSID to obtain the
default subsystem ID at the current position, preceded by the number of token values
returned (which in this case is always 1). #SSGET(V) and #SSPUT(V) use this value
whenever the SSID parameter is omitted or null.
If the default subsystem ID comes from the owner of a list, the version field of SSID is
set to ZSPI^VAL^NULL^VERSION. Your function should therefore omit the version
field when comparing subsystem ID values for equality.
Token Code Type Item Retrieved
ZSPI^TKN^CHECKSUM
INT Checksum flag
ZSPI^TKN^COMMAND
ENUM Command number
ZSPI^TKN^HDRTYPE
UINT Header type
ZSPI^TKN^LASTERR
ENUM Last nonzero SPI status code
ZSPI^TKN^LASTERRCODE
INT2 token-code, c-token-id, or
l-token-id on last error call
ZSPI^TKN^LASTPOSITION
BYTE:8 Position of last token added with SSPUT
ZSPI^TKN^MAX^FIELD^VERSION
UINT Maximum field version
ZSPI^TKN^MAXRESP
INT Maximum response records to return
ZSPI^TKN^OBJECT^TYPE
ENUM Object-type number
ZSPI^TKN^POSITION
BYTE:8 Current position for #SSGET
ZSPI^TKN^SERVER^VERSION
UINT Server RVU
ZSPI^TKN^SSID
SSID Subsystem ID used with #SSINIT
ZSPI^TKN^USEDLEN
UINT Number of bytes used in the buffer