TS/MP 2.5 Management Programming Manual

The notation used for simple tokens in the syntax box is an abbreviated version of the essential

information given in the DDL TOKEN-CODE statement. You can define extensible structured tokens

by using DDL DEFINITION statements.

The order of the tokens in the syntax box is not necessarily the order in which they must occur in

a command or response buffer—except for the ZSPI-TKN-ENDLIST token. The ZSPI-TKN-ENDLIST

token always appears at the end of a list that begins with the ZSPI-TKN-DATALIST or

ZSPI-TKN-ERRLIST token.

Data lists and error lists are always indicated with an ellipsis (...). Data lists begin with the

ZSPI-TKN-DATALIST token (followed by an ellipsis), and error lists begin with the ZSPI-TKN-ERRLIST

token (followed by an ellipsis). Both types of lists (data and error) end with the ZSPI-TKN-ENDLIST

token. The ZSPI-TKN-ENDLIST token is indented to symbolize that it is only used if a list token is

present. For more information on data lists and error lists, see the SPI Programming Manual.

Unlisted Tokens

These tokens can be present in command and response buffers but are not repeatedly listed or

described in each command unless command-specific information is necessary:

Token TypeTokenDescription

N.A.N.A.Message header tokens

ZSPI-TYP-INTZSPI-TKN-MAXRESPResponse-control token

ZSPI-TYP-LIST

ZSPI-TKN-DATALIST

Data list tokens

ZSPI-TYP-SSCTLZSPI-TKN-ENDLIST(These are present only when the

response-control token is used and set

to any nonzero value.)

ZSPI-TYP-INTZSPI-TKN-RETCODEReturn code token

ZSPI-TYP-LIST

ZSPI-TKN-ERRLIST

Error list tokens

ZSPI-TYP-SSCTLZSPI-TKN-ENDLIST(These are returned only when an error

is detected.)

See the descriptions of these tokens earlier in this section. For information about error tokens and

error lists, see “Event Management” (page 163).

Required Tokens and Fields

For each token in the command buffer and for each field of an extensible structured token in the

command buffer, the syntax box contains an indication of whether the token or field must be present

in the command.

For a token, the notation “!r” means that the token must be present (is required) in the command.

The absence of the notation “!r” means that the token is optional. For a field of an extensible

structured token, the notation “!r” means that the field must have a value other than the null value;

a token that is present but has no assigned value is interpreted as having a value of all blanks.

Command Presentation 49