OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide

Writing Your Program
OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide—424822-001
5-50
Editing a Root Object
Data declarations:
INT
status, -- STATUS code
session; -- ID of session
INT(32)
object_id, -- ID of inbound object
retain := OM_FALSE, -- Delete root object in memory
all := OM_FALSE, -- Finish only this root object
remove := MH_REMOVE; -- Delete root object on queue
Procedure call:
status := GPI_MT_FINISH_TRANSFER_IN_ ( session,
object_id,
retain,
all,
remove);
Editing a Root Object
After a successful call to GPI_MT_FINISH_TRANSFER_IN_ , a root object retained in
GPI Library memory space is modifiable; it can be edited. You can use any of the GPI
object management procedures to remove or replace a specific attribute value, group of
attributes, or entire subobject. You might want to do this, for instance, to alter the
distribution list for a root object or to encapsulate one root object into another.
This section has already focused on the composing procedures: GPI_OM_CREATE_ ,
GPI_OM_INSERT_ and GPI_OM_WRITE_ . Following subsections focus on the
copying and decomposing procedures.
The tasks covered in this section are:
•
Removing an attribute value (using GPI_OM_REMOVE_ )
•
Deleting an object (using GPI_OM_DELETE_ )
•
Copying an object (using GPI_OM_COPY_ )
Removing an Attribute Value
You call the GPI_OM_REMOVE_ procedure to remove and discard values of an
attribute. A single call to this procedure can remove either of the following:
•
One attribute value of a single-valued attribute
•
One or more attribute values of a multivalued attribute of the same attribute type
Note. All objects have an attribute of type OM-T-CLASS that cannot be modified or removed.
The OM-T-CLASS attribute exists until its object is deleted.