OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4-12
GPI_MT_FINISH_TRANSFER_IN_
•
If you specify OM-TRUE for the all parameter, objects not processed before an
error condition occurs remain as reserved objects on the input queue. Objects
processed before the error occurs are removed and become the responsibility of the
client.
•
If the status parameter is ZGPI-RC-TMF-ERROR, the object is deleted from the
memory space of the GPI library and placed back on the input queue, as if you
specified MH-CANCEL for the remove parameter.
If the all parameter is OM-TRUE, the GPI does not indicate which objects have
been removed. To recover from this situation, continue to call the
GPI_MT_FINISH_TRANSFER_IN_ procedure until the status parameter is
MH-RC-SESSION-NOT-BUSY, which indicates that you have processed all
reserved objects.
•
After calling the GPI_MT_START_TRANSFER_IN procedure, you can determine
whether to archive a communication by calling the GPI_STATUS_ procedure.
Check the primary code returned for GPI_MT_START_TRANSFER_IN_. If the
value of the primary code is ZGPI-RC-UNDECODABLE-MESSAGE or
ZGPI-RC-UNDECODABLE-CONTENT, it is useful to archive the communication.
You cannot analyze or delete an archived communication by using the GPI
procedures.
•
The MH-TRANSFER value of the remove parameter is only allowed if the
gateway is configured as a P1-EXIT gateway. This option removes the reserved
message from the input message queue and adds it to the output message queue. The
resubmission of this message will give the MTA the responsibility to further process
the message. This option is recommended if the client wants to relay the message, or
if any kind of undecodable error is returned from the
GPI_MT_START_TRANSFER_IN_ call. If the client modifies and then transfers
out a copy of the reserved message, it is recommended that you delete the original
reserved message by specifying the MH-REMOVE value for the remove
parameter in the GPI_MT_FINISH_TRANSFER_IN_ call.