OSI/MHS Management Programming Manual

Commands and Responses
OSI/MHS Management Programming Manual—424824-001
5-7
Attributes, Defaults, and Null Values
Descriptions of simple tokens in this section do not identify their token numbers.
However, the symbolic names of the token numbers can be derived from the token
names by simply replacing -TKN- with -TNM-. For example, the token number of the
ZSPI-TKN-MANAGER token is ZSPI-TNM-MANAGER.
The syntax boxes do not include the SPI header tokens, which are always present in
every command and response buffer. Table 5-4 lists the header tokens that can be
queried using SSGET in response buffers and, in some cases, changed with SSPUT in
command buffers.
For descriptions of these tokens, refer to the SPI Programming Manual and to the
section on SPI standard definitions.
Attributes, Defaults, and Null Values
Many command/object pairs have tokens that describe the object attributes. Some
attributes are required; others are optional. The programmatic interface does not provide
any defaults. Required values must be supplied by whatever software programs use the
programmatic interface.
The token descriptions for each command state whether each token (or field of an
extensible structured token) is required or optional, what its ranges or possible values
are, and what its defaults are, if applicable. Each required field of an extensible
structured token must be assigned a value other than its null value. Optional fields can
also be assigned a value other than the field's null value, but this is not required.
Table 5-4. Header Tokens in Commands and Responses
Token Token Type
ZSPI-TKN-BUFLEN ZSPI-TYP-UINT
ZSPI-TKN-CHECKSUM ZSPI-TYP-BOOLEAN
ZSPI-TKN-COMMAND ZSPI-TYP-ENUM
ZSPI-TKN-HDRTYPE ZSPI-TYP-UINT
ZSPI-TKN-LASTERR ZSPI-TYP-LASTERR
ZSPI-TKN-LASTERRCODE ZSPI-TYP-TOKENCODE
ZSPI-TKN-LASTPOSITION ZSPI-TYP-POSITION
ZSPI-TKN-MAX-FIELD-VERSION ZSPI-TYP-VERSION
ZSPI-TKN-MAXRESP ZSPI-TYP-INT
ZSPI-TKN-OBJECT-TYPE ZSPI-TYP-ENUM
ZSPI-TKN-POSITION ZSPI-TYP-POSITION
ZSPI-TKN-SERVER-VERSION ZSPI-TYP-VERSION
ZSPI-TKN-SSID ZSPI-TYP-SSID
ZSPI-TKN-USEDLEN ZSPI-TYP-UINT