OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4-49
GPI_STATUS_
GPI_STATUS_
This procedure provides additional status and error information about the most recently
reported GPI failure. You can request information about the most recent failure within
the GPI (in any context), within a specified session context, or outside a specified
session context.
status returned value
INT:value
indicates the outcome of the GPI_STATUS_ call. A value of OM-RC-SUCCESS
indicates a successful call. For additional values of status, see Appendix B,
Return Codes.
status-context input
INT:value
specifies the context in which you want error information. You can specify one of
the following:
•
The session identifier of an established session to obtain information about the
last error that occurred in that session.
•
The value ZGPI-ANY to obtain information about the last GPI call that occurred
in any session (successfully or unsuccessfully).
•
The value ZGPI-NON-SESSION to obtain information about the last error that
occurred outside a session context.
If you omit this parameter, the default value is ZGPI-ANY.
session output
INT.EXT:ref:1
is the session identifier of the session to which the status information applies.
status := GPI_STATUS_ ( [ status-context ] ! I
, [ session ] ! O
, [ request-type ] ! O
, [ old-status ] ! O
, [ error-class ] ! O
, [ primary-code ] ! O
, [ secondary-code ] ! O
, [ error-qualifier ] ! O
, [ error-source ] ! O
, [ info-buffer ] ! O
, [ info-buffer-length ] ! I
, [ actual-info-length ] ! O
, [ total-info-length ] ) ; ! O