OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide

The GPI Library
OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide—424822-001
2-2
Environment Management Procedures
All GPI procedures share the following characteristics:
•
Each has a status parameter that indicates the outcome of the procedure call. If
status indicates an error, the procedure has failed, and the client application
should branch to a diagnostic routine.
•
Each might have input parameters, output parameters, or both. In most cases,
defaults are provided for input parameters.
Environment Management Procedures
Environment management procedures control the gateway and provide diagnostic help.
Specifically, the procedures are used for the following operations:
•
Initializing the GPI environment
•
Managing sessions
•
Retrieving error information
Table 2-2
lists each environment management procedure and its purpose.
GPI_INITIALIZE_
The GPI_INITIALIZE_ procedure is used to initialize the GPI environment. It must be
the first procedure called in any client program (Figure 2-1). GPI_INITIALIZE_ sets up
GPI_STATUS_ GPI_OM_REMOVE_ GPI_MT_FINISH_TRANSFER_IN_
GPI_OM_DELETE_
GPI_OM_EXAMINE_
GPI_OM_FETCH_
GPI_OM_LIST_
GPI_OM_READ_
GPI_OM_COPY_
Table 2-2. Environment Management Procedures
Procedure Name Purpose
GPI_INITIALIZE_ Initializes workspace for GPI procedures
GPI_OPEN_ Opens a session
GPI_CLOSE_ Closes a session
GPI_STATUS_ Retrieves error information
Table 2-1. GPI Library Procedures (page 2 of 2)
Environment
Management Object Management Message Transfer