OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Return Codes
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B-10
GPI_STATUS_ Information
GPI_STATUS_ Information
When your program calls GPI_STATUS_ , the following types of information are
returned:
Request Types
Request types are returned by GPI_STATUS_ to indicate the GPI procedure in which the
most recently returned error occurred. Table B-3 summarizes the request types.
Request type Indicates the GPI procedure in which the most recent error
occurred.
Error class Indicates the severity of an error and the recommended recovery
action.
Old status Is the status returned to the procedure that caused the error,
usually an XAPIA standard return code (OM-RC- or MH-RC-
code). If returned from GPI_INITIALIZE_ or GPI_STATUS_ ,
the value can be a Compaq proprietary code (ZGPI-RC- code).
Primary code Indicates a more specific cause of the error. If old status is a
standard code other than OM-RC-PERMANENT-ERROR or
OM-RC-TEMPORARY-ERROR, the primary code is the same
as old status. Otherwise, the primary code is a ZGPI-RC- code.
Secondary code Provides another level of detail about the error. Secondary codes
identified by a DDL name are described in “Secondary Codes,”
later in this section. Values returned in this parameter that are
not identified by a DDL name are described with the recovery
recommendation for the X.400 API or Compaq proprietary
codes to which they apply.
Information buffer Provides detailed information about one or more of the
following errors:
•
An incorrect attribute
•
One or more dangling objects (objects that have been created
but not inserted in the current root object)
•
Internal GPI error codes in one of three structures described
in “Information Buffer,” later in this section
To check the information buffer, refer to the OSI/MHS Gateway
Programmatic Interface (GPI) Programming Guide.