OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4-2
Procedure Names and Categories
The GPI procedures fall into three major categories:
•
GPI environment management procedures enable you to initialize and manage a GPI
session and retrieve information about error conditions. The names of these
procedures have only the GPI_ prefix.
•
GPI object management procedures enable you to create, manage, and examine
objects. The names of these procedures have the prefix GPI_OM_.
•
GPI message transfer procedures enable you to transfer objects from the GPI
service’s input queue and to the GPI service’s output queue. The names of these
procedures have the prefix GPI_MT_.
Table 4-1
summarizes the set of environment management procedures.
Table 4-2
summarizes the set of object management procedures.
Table 4-3
summarizes the set of message transfer procedures.
Table 4-1. GPI Environment Management Procedures
Procedure Name Purpose
GPI_CLOSE_ Ends a GPI session between a client and the GPI service.
GPI_INITIALIZE_ Sets up an environment in which other GPI procedures can operate.
GPI_OPEN_ Establishes a GPI session between a client and the GPI service.
GPI_STATUS_ Provides additional status and error information about the most recent
GPI failure.
Table 4-2. GPI Object Management Procedures
Procedure Name Purpose
GPI_OM_COPY_ Creates an exact but independent copy of an object and its
subobjects.
GPI_OM_CREATE_ Creates a new object of a specified class.
GPI_OM_DELETE_ Deletes an object and invalidates its identifier.
GPI_OM_EXAMINE_ Identifies the types of attributes present in an object and,
optionally, gives the syntax and values of single-valued attributes.
GPI_OM_FETCH_ Indicates whether specific types of attributes are present in an
object and, optionally, gives the syntax and values of single-
valued attributes.
GPI_OM_INSERT_ Adds attribute values to an object.
GPI_OM_LIST_ Retrieves values of multivalued attributes of an object.
GPI_OM_READ_ Reads a segment of a string value of a specified type of attribute.
GPI_OM_REMOVE_ Removes and discards attribute values of an object.
GPI_OM_WRITE_ Writes a segment of a string value of a specified type of attribute.