TACL Reference Manual

Built-In Functions and Variables
HP NonStop TACL Reference Manual—429513-018
9-372
#SSGET Built-In Function
get-op
is one of these:
token-code
directs #SSGET to return the token value or values associated with token-
code. If token-code is a token that marks the beginning of a list, #SSGET
selects the list so that subsequent calls can retrieve tokens within the list. If
token-code is ZSPI^TKN^ENDLIST, #SSGET pops out of the list.
token-code can be any of the header tokens described for the #SSGET
Built-In Function on page 9-371 and #SSGETV Built-In Function on
page 9-376. You can also supply the token ZSPI^TKN^DEFAULT^SSID to
obtain the default subsystem ID at the current position.
ZSPI^TKN^COUNT c-token-id
directs #SSGET to return the number of occurrences of the token specified by
the token code or the token map c-token-id, starting with the occurrence
specified by index. To count all occurrences in the current list, specify an index
of 1.
If c-token-id is omitted or equal to ZSPI^VAL^NULL^TOKENCODE, and
index is omitted or zero, #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. This is the size of the buffer needed to
contain the stated 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.
If you omit this option, or if l-token-id is equal to
ZSPI^VAL^NULL^TOKENCODE, and index is omitted or zero, #SSGET
returns the length of the current occurrence of the current token.
If l-token-id is a token map, this operation returns the length contained in
that map; the actual value in the buffer can differ from this length. To get the
actual length of the token value in the buffer, invoke #SSGET with
ZSPI^TKN^LEN and a token code made up of ZSPI^TYP^STRUCT and the
token number from the token map. This invocation returns the length of the
structure value, including two bytes for the length field. Subtract 2 from this
value to get the length of the value itself.
ZSPI^TKN^NEXTCODE
directs #SSGET to return the next token code that is different from the current
token code, followed by the subsystem ID. The subsystem ID returned in the
result always has a version field of zero (null).