OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Return Codes
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
B-3
0 OM-RC-SUCCESS
0 OM-RC-SUCCESS
Cause. The operation was successfully completed.
Effect. The application can proceed with the next step.
Recovery. None is required.
2 OM-RC-FUNCTION-DECLINED
Cause. The procedure you called performs a function that does not apply to the object
you specified. For example, you tried to transfer out an object that is not a root object.
Effect. The function is not performed.
Recovery. Call GPI_STATUS_ and check the error class and the secondary code (prefix
ZGPI-FDC-). Take the recovery action recommended for the error class.
PERMANENT-ERROR 20 Service encountered an error condition (more
serious than a warning condition).
POINTER-INVALID 21 Invalid pointer specified as a parameter
(argument).
SYSTEM-ERROR 22 Service encountered a GPI or operating system
error.
TEMPORARY-ERROR 23 Service encountered a temporary error (warning
condition).
TOO-MANY-VALUES 24 Limit to number of values in object exceeded.
VALUES-NOT-ADJACENT 25 Descriptors for values of an attribute are not
adjacent.
WRONG-VALUE-LENGTH 26 Attribute value exceeds length limit.
WRONG-VALUE-MAKEUP 27 Attribute value violates valid syntax constraint.
WRONG-VALUE-NUMBER 28 Specified number does not refer to an existing
value.
WRONG-VALUE-SYNTAX 29 Specified syntax not valid for attribute.
WRONG-VALUE-TYPE 30 Specified attribute type not valid for object.
Note. Three ZGPI-RC- codes defined in the DDL file are equivalent to OM-RC- codes.
Specifically, ZGPI-RC-SUCCESS is equivalent to OM-RC-SUCCESS,
ZGPI-RC-OTHER-ERROR is equivalent to OM-RC-PERMANENT-ERROR,
ZGPI-RC-WARNING is equivalent to OM-RC-TEMPORARY-ERROR. Use the DDL name that
follows the conventions for application development in your organization and makes your
program most readable.
Table B-1. Return Code Values for Object Management (page 2 of 2)
Constant (OM-RC-) Value Meaning