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

The SPI Procedures
SPI Programming Manual—427506-006
3-14
Special Operations With SSGET and SSGETTKN
described by the token-id. If not supplied, it defaults to one. If less than zero,
it causes an error.
•
On return, it specifies the actual number of token values returned.
If a count greater than one is specified, SSGET or SSGETTKN continues
searching until it either satisfies the requested count or reaches the end of the
buffer or list.
For certain tokens for special operations, SSGET and SSGETTKN use the
count
parameter to return attribute information such as length, byte offset, or number of
occurrences.
ssid input, output
INT .EXT:ref:6
is a subsystem ID that qualifies the token code. If not supplied or equal to zero
(6*[0]),
ssid defaults to one of:
•
If the current-token pointer is in a list, the subsystem ID of the current list
•
If the current-token pointer is not in a list, the subsystem ID in the SPI message
header (ZSPI-TKN-SSID)
The version field of this parameter is not used when searching the buffer.
Special Operations With SSGET and SSGETTKN
Table 3-2 lists the special token codes you can supply to SSGET and SSGETTKN to
retrieve header token values and perform other special operations.
Each operation is described following the table. For some operations, the procedure
parameters differ in type and meaning from those indicated in the main syntax
description. Modified syntax and semantics are given, or the differences are described.
Table 3-2. SSGET(TKN) Special Operations (page 1 of 2)
Token Specified in SSGET(TKN) Call Type Effect
ZSPI-TKN-ADDR TOKENCODE Retrieve the address of a
token
ZSPI-TKN-BUFLEN UINT Retrieve buffer length
ZSPI-TKN-CHECKSUM BOOLEAN Retrieve checksum flag
ZSPI-TKN-COMMAND ENUM Retrieve command number
ZSPI-TKN-COUNT TOKENCODE Count the occurrences of a
token
ZSPI-TKN-DEFAULT-SSID SSID Retrieve SSID at current
position
ZSPI-TKN-HDRTYPE UINT Retrieve message header
type