OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B-1
B
Return Codes
This appendix provides the information you need to check the status of a procedure call
and determine the cause of failures. The following information is provided:
•
A method for checking the status of a procedure call
•
The values of return codes passed in the status parameter of each procedure (as
well as in the old-status and primary-code parameters of the
GPI_STATUS_ procedure)
•
Descriptions of the various types of information returned by the GPI_STATUS_
procedure: request types, error classes, primary codes, and secondary codes.
•
Descriptions of the five versions of information returned in the GPI_STATUS_
information buffer
Status Checking
Each GPI procedure returns a code in the status parameter that indicates the success
or failure of the procedure call. You can use the DDL constants that represent return
codes to check the value returned. The types of codes returned are identified by the
following prefixes:
In most cases, ZGPI-RC- codes are returned by the GPI_STATUS_ procedure as
primary codes. However, the following codes can be returned in the status parameter
of any procedure:
ZGPI-RC-USESEGMENT-ERROR
ZGPI-RC-MISSING-REQUIRED-PARAMETER
ZGPI-RC-MISSING-OPTIONAL-PARAMETER
ZGPI-RC-PARAMETER-OUT-OF-BOUND
ZGPI-RC-PARAMETER-OUT-OF-RANGE
For descriptions of these codes, see Compaq Proprietary Codes on page B-14
on
page B-14.
A value of OM-RC-SUCCESS (zero) indicates that the procedure was successful. If the
value is greater than OM-RC-SUCCESS, you can do either of the following:
•
Take immediate action based on the status. For example, the return code
MH-RC-NOT-RESERVED indicates you tried to perform an operation on an object,
OM-RC- Object-management return codes that conform to the XAPIA-1988
specification
MH-RC- Message-handling return codes that conform to the XAPIA-1988
specification
ZGPI-RC- Compaq proprietary return codes