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

The SPI Procedures
SPI Programming Manual—427506-006
3-13
General Syntax
is the SPI buffer from which information is to be extracted.
token-id input
INT .EXT:ref:* (SSGET)
INT(32):value (SSGETTKN)
is a token code or (for SSGET only) a token map. This parameter normally
identifies the token to be retrieved. If the
token-id is one of the SPI standard
token codes indicating a special operation, the interpretation of the
token-value,
count, and index parameters can vary from the descriptions here.
If
token-id is a token that marks the beginning of a list (ZSPI-TKN-DATALIST,
ZSPI-TKN-ERRLIST, ZSPI-TKN-SEGLIST, or ZSPI-TKN-LIST), the procedure
selects the list so that subsequent calls can retrieve tokens in the list.
token-value input, output
STRING .EXT:ref:*
is normally the variable in which the requested token value is to be returned. For
control and positioning operations,
token-value can be an output parameter. Its
data representation depends on the token-type field of the
token-id.
index input
INT:value
if greater than zero, specifies an absolute index for
token-id, starting from the
beginning of the buffer or current list. An
index of one gets the first occurrence of
that token code, an
index of two gets the second occurrence, and so on.
if zero or not supplied, returns the next occurrence of the token code following the
current-token pointer in the buffer. For example, if the token occurs five times,
calling SSGET or SSGETTKN once with an
index of one and four times with
index 0 would return all five occurrences.
if less than zero, returns an error.
SSGET resets the current-token pointer to the token value returned if no error is
reported by the procedure.
To search from the beginning of the buffer or current list, a program must either
supply a nonzero
index or first reset the initial position (using SSPUT or
SSPUTTKN with ZSPI-TKN-INITIAL-POSITION or ZSPI-TKN-RESET-BUFFER).
count input, output
INT .EXT:ref:1
is normally used as an input and output count parameter:
•
On the call, it specifies the maximum number of token values to return. The
token-value parameter is an array of count elements, each of which is