OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide

Writing Your Program
OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide—424822-001
5-48
Finishing Transfer-in of a Root Object
You can do either of the following with the root object in the GPI library memory space:
•
Retain the object in a modifiable state (for editing)
•
Delete the object
Parameters for GPI_MT_FINISH_TRANSFER_IN_ are:
session (input)
object (input)
retain (input; optional)
all (input; optional)
remove (input; optional)
session specifies the identifier of the GPI session for which the object is reserved.
object specifies the identifier of the reserved object. If you specify OM-TRUE as the
value of all, the object parameter is ignored.
retain specifies whether you want to retain the root object in GPI library memory
space after this procedure call completes, as follows:
•
OM-TRUE specifies that you want to retain the object. The object is the
responsibility of the client program, which can inspect and edit the object.
•
OM-FALSE specifies that you do not want to retain the object. The effect of
OM-FALSE is the same as specifying OM-TRUE and then calling the
GPI_OM_DELETE_ procedure.
Figure 5-13. Using GPI_MT_FINISH_TRANSFER_IN_
Note. If you specify OM-TRUE for retain, the root object will be retained in the GPI library
space and made modifiable. This makes GPI_OM_COPY_ unnecessary. Extra copies affect
performance and occupy additional space in the GPI library process. This is an especially
important consideration in the case of a P1-EXIT type gateway, which receives all X.400 traffic
relayed to the local MTA.
513CDT .CDD
GPI Library Memory Segment
Attribute
Attribute
Attribute
OBJECT
Attribute
Object is:
1. now modifiable
2. deleted
or
Input Queue
Message,
Probe, or
Report
Object is:
1. now unreserved
2. archived
3. deleted
4. transferred
or
or
or