GDSX Management Programming Manual

GDSX Management Programming Manual529930-001
7-1
7 Error Numbers and Error Lists
This section describes all the error numbers provided by the GDS subsystem (that is,
the values whose symbolic names begin with ZGDS-ERR) and describes the error lists
associated with these error numbers. These error numbers can occur as values of the
return token, ZSPI-TKN-RETCODE, and as part of the value of the error token, ZSPI-
TKN-ERROR.
For a description of what error lists are and how they are retrieved from the buffer,
refer to the SPI Programming Manual. For general information about how the GDS
subsystem handles errors in the token-oriented programmatic interface, refer to
Section 3, SPI Programming Considerations.
In this section, all tokens and their values are represented in DDL. For a brief
explanation of DDL as it applies to SPI, refer to the SPI Programming Manual.
Notation Used
For each error-list description on the following pages, there is a box that lists all of the
tokens that can appear in the error list. Included in the list are the tokens ZSPI-TKN-
ERRLIST and ZSPI-TKN-ENDLIST, which start and end all error lists. With the
exception of ZSPI-TKN-ERRLIST and ZSPI-TKN-ENDLIST, the order of the tokens in
the list can vary.
The notation used in the box for simple tokens is a shorthand version of the essential
information given in the DDL TOKEN-CODE statement.
Following the box, each token in the box except ZSPI-TKN-ERRLIST and ZSPI-TKN-
ENDLIST is described in the same order in which it appears in the box. These two
tokens serve the same function in all error lists. More information about these tokens
can be found in the SPI Programming Manual.
Error Lists
An error list contains a group of tokens that together form a complete description of a
single error. Table 7-1 lists the tokens that are always present in an error list.
Table 7-1. Error List Tokens (page 1 of 2)
Token Description
ZSPI-TKN-ERRLIST This token marks the beginning of an error list. It
identifies an error list containing additional information
about an error reported in ZSPI-TKN-RETCODE.
ZSPI-TKN-ENDLIST This token marks the end of an error list.
ZSPI-TKN-ERROR This token contains the GDS subsystem ID and an
error number. Error numbers are represented by
symbolic names of the form ZGDS-ERR-message,
where message names the error.