OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Return Codes

OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001

B-15

2000 ZGPI-RC-MISSING-REQUIRED-PARAM

Cause. Your program did not pass a required parameter in a procedure call.

Effect. The function is not performed.

Recovery. Revise the call to include the required parameter. You can call

GPI_STATUS_ and check the secondary code, which indicates the position of the

parameter that is missing.

2001 ZGPI-RC-PARAMETER-OUT-OF-BOUND

Cause. Your program passed a parameter that is not the correct length or its address is

invalid. The parameter might be the wrong type or might need to be initialized. (This

code can be returned as the status of GPI_INITIALIZE_ and GPI_STATUS_ .)

Effect. The function is not performed.

Recovery. Correct the procedure call using a valid parameter. You can call

GPI_STATUS_ and check the secondary code, which indicates the position of the

incorrect parameter.

2002 ZGPI-RC-MISSING-OPTIONAL-PARAM

Cause. You did not specify an optional parameter that is required because of the value

specified for another parameter. For example, if you are copying a root object, you must

include the copy-session parameter in the GPI_OM_COPY_ call. (This code can

be returned as the status of GPI_STATUS_ .)

Effect. The function is not performed.

Recovery. Revise the procedure call to include the optional parameter. You can call

GPI_STATUS_ and check the secondary code, which indicates the position of the

parameter that is missing.

PARAMETER-OUT-OF-RANGE 2003 Parameter value not within valid range.

INT-PARAM-OUT-OF RANGE 2004 Internal parameter value not within valid

range.

INT-PARAM-OUT-OF-BOUND 2005 Internal parameter length or address is

incorrect.

MISSING-INT-OPT-PARAM 2006 Optional internal parameter (required because

of presence of another parameter) is missing.

MISSING-INT-REQ-PARAM 2007 Required internal parameter is missing.

Table B-5. ZGPI-RC- Codes for Parameter-Validation Errors

Constant (ZGPI-RC-) Value Meaning