OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide

Writing Your Program
OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide—424822-001
5-4
Developing Program Structure
The remainder of this section describes each GPI procedure within the context of the
task each performs. Each description includes a list of input and output parameters and
a sample procedure call in the TAL language. Each procedure call is preceded by data
declarations that define (and in some cases initialize) parameters used in the call.
Figure 5-1. GPI Program Flow: Sequence of Procedures
501CDT .CDD
GPI Procedure
Outbound Processing
Build root object
Transfer out root object
Inbound Processing
Finish transfer-in of root object
Initiate transfer-in of root object
Edit root object
(Modifiable object)
Close a session
Open a session
Program Flow
Note: GPI_STATUS_ may
be used anytime after
successful GPI_INITIALIZE_
Initialize workspace
GPI_MT_WAIT_
GPI_MT_START_TRANSFER_IN_
GPI_MT_FINISH_TRANSFER_IN_
GPI_CLOSE_
GPI_INITIALIZE_
GPI_OPEN_
GPI_MT_TRANSFER_OUT_
Composing:
GPI_OM_CREATE_
GPI_OM_INSERT_
GPI_OM_WRITE_
Decomposing:
GPI_OM_DELETE_
GPI_OM_REMOVE_
Inspecting:
GPI_OM_EXAMINE_
GPI_OM_FETCH_
GPI_OM_LIST_
GPI_OM_READ_
Copying:
GPI_OM_COPY_
Composing:
GPI_OM_CREATE_
GPI_OM_INSERT_
GPI_OM_WRITE_
Decomposing:
GPI_OM_DELETE_
GPI_OM_REMOVE_
Copying:
GPI_OM_COPY_
Inspecting:
GPI_OM_EXAMINE_
GPI_OM_FETCH_
GPI_OM_LIST_
GPI_OM_READ_
Composing:
GPI_OM_CREATE_
GPI_OM_INSERT_
GPI_OM_WRITE_
Decomposing:
GPI_OM_DELETE_
GPI_OM_REMOVE_
Inspecting:
GPI_OM_EXAMINE_
GPI_OM_FETCH_
GPI_OM_LIST_
GPI_OM_READ_
Copying:
GPI_OM_COPY_
Retrieve information from root
object (Unmodifiable object)