OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4-10
GPI_MT_FINISH_TRANSFER_IN_
GPI_MT_FINISH_TRANSFER_IN_
This procedure changes the state of a reserved object. There are four options. You can
remove the object permanently from the GPI service’s input queue, move the object
from the input queue to the archive queue, make the object unreserved and leave it in the
input queue, or remove the object from the input queue and resubmit it to the MTA.
With all four options you have the ability to retain the object and its object identifier in
client memory and process it as you would a newly created object. The retained object is
the responsibility of your client program. If you leave the object in the input queue, you
can call the GPI_MT_START_TRANSFER_IN_ procedure to process it again.
status returned value
INT:value
indicates the outcome of the call. A value of OM-RC-SUCCESS indicates a
successful call. For additional values of status, see Appendix B, Return Codes
.
session input
INT:value
specifies the session identifier of the established GPI session for which the object is
reserved.
object input
INT(32):value
specifies the object identifier of the reserved object. If you specify OM-TRUE as the
value of the all parameter, the object parameter is ignored.
retain input
INT(32):value
specifies whether you want to retain the object after this procedure call completes.
The value can be:
status := GPI_MT_FINISH_TRANSFER_IN_ ( session ! I
, object ! I
, [ retain ] ! I
, [ all ] ! I
, [ remove ] ) ; ! I
OM-TRUE specifies that you want to retain the object. All client program
resources associated with the retained object remain allocated.
The object is the responsibility of the client program, which can
examine and modify 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.