OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4-11
GPI_MT_FINISH_TRANSFER_IN_
If you omit this parameter, the default value is OM-FALSE.
all input
INT(32):value
specifies whether you want to change the state of all currently reserved objects or
only the object specified in the object parameter.
The value can be:
If you omit this parameter, the default value is OM-FALSE.
remove input
INT(32):value
specifies what you want to do with the object. You can remove the object
permanently from the input queue, move the object from the input queue to the
archive queue, leave the object in the input queue as an unreserved object, or
remove the object from the input queue and resubmit it to the MTA. Leaving the
object on the unreserved input queue has the effect of cancelling the object’s transfer
in, returning to the situation before you called GPI_MT_START_TRANSFER_IN_
to reserve the object.
The value can be:
If you omit this parameter, the default value is MH-REMOVE.
Considerations
•
You should call this procedure after your application successfully processes an
object, as follows:
•
If the object is a message or report, the client application delivers or internally
transfers the object to the indicated users of the messaging system to which your
client application is a gateway.
•
If the object is a probe, the client application establishes the deliverability to
prescribed users of a message having prescribed characteristics.
OM-TRUE specifies that the procedure operates on all currently reserved
objects.
OM-FALSE specifies that the procedure operates on only one object.
MH-CANCEL specifies leaving the unreserved object on the input queue.
MH-REMOVE specifies removing the object from the input queue.
MH-ARCHIVE specifies moving the object from the input queue to the
archive queue.
MH-TRANSFER specifies removing the object from the input queue and
resubmitting that object to the MTA. This value can only be
used by a P1-EXIT type gateway.