OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide

The GPI Library
OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide—424822-001
2-6
Object Management Procedures
The GPI_OM_CREATE_ procedure creates a new object of a specified class.
Optionally, it can also add to this object a set of default attributes and their values.
GPI_OM_CREATE_ returns an object identifier for the newly created object; you refer
to this identifier in all procedure calls that operate on the object.
The GPI_OM_INSERT_ procedure adds attribute values to an object. A single call to
this procedure can insert either a list of values for single-valued attributes or a list of
values for a multivalued attribute; it can also add a combination of both.
The GPI_OM_WRITE_ procedure writes a segment of a data string to a value of a
specified type of attribute. A segment is a portion of a string made up of zero or more
contiguous octets. You call this procedure as many times as needed to add all segments
of the string. Each call returns a starting position for the next call.
GPI_OM_REMOVE_ and GPI_OM_DELETE_
Object management decomposing procedures are listed in Table 2-4. Decomposing
procedures take apart objects rather than build them. They are typically used when
editing objects, either during outbound processing or at the final stage of inbound
processing, as described later.
The GPI_OM_REMOVE_ procedure removes and discards values of an attribute of an
object. A single call to this procedure can remove either a value for a single-valued
attribute or a list of values for a single type of multivalued attribute.
The GPI_OM_DELETE_ procedure deletes an object by invalidating the object
identifier and releasing all resources allocated by the GPI for the object. Note that all
objects contained in the deleted object are also deleted.
GPI_OM_EXAMINE_ , GPI_OM_FETCH_ , GPI_OM_LIST_ ,
and GPI_OM_READ_
Object management inspecting procedures are listed in Table 2-5. Inspecting
procedures are used to retrieve information from objects. This is generally done when a
root object is first transferred in. However, inspecting procedures can be used at any
time during outbound or inbound processing.
Table 2-4. Object Management Decomposing Procedures
Procedure Name Purpose
GPI_OM_REMOVE_ Removes and discards attribute values of an object
GPI_OM_DELETE_ Deletes an object and invalidates its identifier