OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Return Codes
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B-2
Standard X.400 API Return Codes
such as finishing a transfer-in, but the object is not reserved. In this case, you might
be able to recover without further information.
•
Call the GPI_STATUS_ procedure to request more information about the cause of a
failure. You can request information about the last error in a specific session, the
last procedure call in any session, or the last error that occurred outside a session.
The GPI_STATUS_ procedure returns a primary code, secondary code, and error
class, along with other useful information. For example, if the return code is
OM-RC-NO-SUCH-OBJECT, you can call GPI_STATUS_ to get the secondary
code value. In this case, the secondary code indicates the specific cause of the error;
for example, the secondary code ZGPI-NSOC-ELMT-ALREADY-DELETED
indicates the object you specified has already been deleted.
When you call the GPI_STATUS_ procedure, first check the status parameter to
make sure your request for more information was successful. Next, consider the other
information returned to determine what action to take. For more information about
recovering from errors, see GPI_STATUS_ Information
on page B-10.
Standard X.400 API Return Codes
This subsection describes the standard return codes that can be values of the status,
old-status, and primary-code parameters.
Object-Management Return Codes
Table B-1 summarizes the OM-RC- return codes you can receive from an object
management procedure and explains what they mean. A more detailed description of
each value follows the table. (The OM-RC-SUCCESS code is also returned to message
handling procedures that succeed.)
Table B-1. Return Code Values for Object Management (page 1 of 2)
Constant (OM-RC-) Value Meaning
SUCCESS 0 Operation succeeded.
FUNCTION-DECLINED 2 Function does not apply to object or cannot be
performed.
FUNCTION-INTERRUPTED 3 Function aborted because of action taken by client
program unrelated to GPI procedure calls.
MEMORY-INSUFFICIENT 4 More main memory needed.
NETWORK-ERROR 5 Service could not employ required network.
NO-SUCH-CLASS 6 Specified class is undefined.
NO-SUCH-OBJECT 9 Specified object is undefined.
NO-SUCH-SYNTAX 12 Specified syntax is undefined.
NO-SUCH-TYPE 13 Specified type is undefined.
NOT-PRESENT 17 Attribute value is not present.