EMS Manual

Distributor Commands and Responses
EMS Manual—426909-005
17-9
Common Definitions for ZEMS- Commands
it is non-zero, an error occurred, and the response record contains an error list that
describes the error.
ZSPI-TKN-ERRLIST
indicates the beginning of an error list. ZSPI-TKN-ENDLIST indicates the end of
the error list, and the error list can be nested. An error list is put in the response for
each error or warning encountered during processing of the command. ZSPI-TKN-
ERROR is the only required token for the error list. Other standard or subsystem-
specific tokens can also be in the error list, depending on the type of error.
ZSPI-TKN-ERROR
specifies the error and identifies the subsystem that prepared the error list.
Common Definitions for ZEMS- Commands
This subsection describes some tokens and error numbers that commonly occur in
several ZEMS- command messages.
Common Command Tokens
Common command tokens are defined here in alphabetical order. Most are defined
with the command message in which they are used.
Token types that are abbreviated in italics represent SPI types. For example, int
represents ZSPI-TYP-INT.
ZSPI-TKN-COMMAND (type enum)
is the standard SPI token, which can have these values for the distributor’s basic
SPI interface:
ZEMS-CMD-GETVERSION 0
ZEMS-CMD-STATUS 1
ZEMS-CMD-CONTROL 2
ZEMS-CMD-GETEVENT 3
ZSPI-TKN-ENDLIST (type ssctl)
is the SPI token used to end lists, including the command error lists in this section
of the manual.
ZSPI-TKN-ERRLIST (type list)
is the SPI token that begins an error list.
ZSPI-TKN-RETCODE (type enum)
is the standard SPI return token. For ZSPI-TKN-RETCODE values and related
information, see Section 21, Distributor Errors.