Guardian Procedure Errors and Messages Manual

13 SEGMENT_USE_Errors
This section contains the error list associated with the SEGMENT_USE_ procedure. This procedure
selects a particular extended data segment to be currently addressable by the calling process.
Note that the SEGMENT_USE_ procedure is similar to the USESEGMENT procedure. You can
typically use the SEGMENT_USE_ procedure on D-series and later releases, while you used the
USESEGMENT procedure on C-series releases. For the error list associated with the USESEGMENT
procedure, see “SEGMENT_USE_Errors” (page 211).
Also for error codes and error lists associated with the ALLOCATESEGMENT procedure, see
“USESEGMENT Errors” (page 209) and “ALLOCATESEGMENT Errors” (page 200). For error codes
and error lists associated with the SEGMENT_ALLOCATE_ procedure, see “SEGMENT_ALLOCATE_
and SEGMENT_ALLOCATE64_ Errors” (page 204).
Error Lists
If you are using the Subsystem Programmatic Interface (SPI) to send commands to a subsystem,
you might receive a SEGMENT_USE_ error list in a response. Subsystems return such an error list
when, in performing your request, they call the SEGMENT_USE_ procedure directly or indirectly
and an error occurs on the call.
The standard SPI token ZSPI-TKN-PROC-ERR, which is present in every SEGMENT_USE_ error list,
identifies the procedure. Its value is ZGRD-VAL-SEGMENT-USE (23).
The error list always includes the unconditional tokens listed under its description in this section.
In addition, the error list can include any of the conditional tokens listed under its description.
If you are designing a subsystem that uses SPI, follow these guidelines when constructing a
SEGMENT_USE_ error list:
• Include all unconditional tokens listed in the error-list description.
• Optionally include any or none of the conditional tokens listed in the error-list description.
This section does not discuss the mechanics of error-list construction. For information about creating
error lists, additional information about tokens and token types, and definitions of tokens whose
names begin with ZSPI-, see the SPI Programming Manual.
23: ZGRD-VAL-SEGMENT-USE
A call to SEGMENT_USE_ returned a nonzero error as the function value. There are several possible
causes of the error, as explained below.
Unconditional Tokens
ZSPI-TKN-ERRLIST token-type ZSPI-TYP-LIST.
ZSPI-TKN-ERROR token-type ZSPI-TYP-ERROR.
ZSPI-TKN-PROC-ERR token-type ZSPI-TYP-ENUM.
ZSPI-TKN-ENDLIST token-type ZSPI-TYP-SSCTL.
Conditional Tokens
ZGRD-TKN-XOBJECTFILE token-type ZSPI-TYP-STRING.
ZGRD-TKN-SEGMENTID token-type ZSPI-TYP-INT.
ZGRD-TKN-OLDSEGMENT token-type ZSPI-TYP-INT.
ZGRD-TKN-ERRORDETAIL token-type ZSPI-TYP-INT.
Unconditional Tokens
ZSPI-TKN-ERROR is the standard SPI error token, whose value consists of the fields Z-SSID and
Z-ERROR. Z-SSID is the subsystem identifier ZGRD-VAL-SSID. Z-ERROR is the error code returned
in the error return value of SEGMENT_USE_.
ZSPI-TKN-PROC-ERR is the procedure in which the error occurred. Its value is
ZGRD-VAL-SEGMENT-USE (23).
Error Lists 211