OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide

The GPI Library
OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide—424822-001
2-7
Message Transfer Procedures
The GPI_OM_EXAMINE_ procedure identifies the types of single-valued and
multivalued attributes in an object and, optionally, the syntax and values of single-
valued attributes.
The GPI_OM_FETCH_ procedure allows you to check whether specific attribute types
are in an object. Optionally, you can request the syntax and values of single-valued
attributes.
The GPI_OM_LIST_ procedure identifies values of a multivalued attribute of an object;
it is the only GPI procedure that can do so.
The GPI_OM_READ_ procedure reads a segment of a data string from a value of a
specified type of attribute. You call this procedure as many times as needed to read all
segments of the value. Each call returns a starting position for the next call.
GPI_OM_COPY_
At any point during outbound or inbound processing, you can also copy an object. The
GPI_OM_COPY_ procedure creates a new object that is an exact but independent copy
of a specified object. The new object includes all objects contained in the object you are
copying.
Message Transfer Procedures
Message transfer procedures are listed in Table 2-6. Message transfer procedures are
used to transfer root objects into or out of the gateway. Outbound transfer is a single-
stage process. Inbound transfer is a two-stage process: it has a starting stage and a
finishing stage.
Table 2-5. Object Management Inspecting Procedures
Procedure Name Purpose
GPI_OM_EXAMINE_ Identifies the type of an object’s attributes
GPI_OM_FETCH_ Allows you to check whether specific attributes are present in an
object
GPI_OM_LIST_ Identifies values of multivalued attributes of an object
GPI_OM_READ_ Reads a segment of a data string from an attribute value
Table 2-6. Message Transfer Procedures
Procedure Name Purpose
GPI_MT_TRANSFER_OUT_ Allows a client to transfer out information
GPI_MT_WAIT_ Allows a client to check for inbound information
GPI_MT_START_TRANSFER_IN_ Allows a client to transfer in and inspect inbound
information
GPI_MT_FINISH_TRANSFER_IN_ Allows a client to edit inbound information