OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4-16
GPI_MT_TRANSFER_OUT_
GPI_MT_TRANSFER_OUT_
This procedure adds an object to the output queue of the GPI service. The object must be
a message, probe, report, or P1-encoded object and must not be reserved. You can retain
the object and add a copy to the output queue. If you do not retain the object, the GPI
service assumes responsibility for it, and you have no more access to it.
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 session from which the object is
transferred out.
object input
INT(32):value
specifies the object identifier of the object that is to be transferred out. The class of
the object must be a message, probe, report, or P1-encoded object.
local-identifier output
STRING .EXT:ref:*
is a local identifier that uniquely identifies the object being transferred out. If this
procedure is successful, the GPI returns the local identifier, which is a string of up to
32 alphanumeric characters. You can concatenate the local identifier with the
attributes of the environment object (class MH-C-ENVIRONMENT) returned by
the GPI_OPEN_ procedure to form an MTS identifier for the object that is being
transferred out. This parameter remains unchanged if the object being transferred is
an instantiation of class MH-C-P1-ENCODED-PDU.
local-identifier-length output
INT.EXT:ref:1
is the length (in octets) of the local identifier.
status := GPI_MT_TRANSFER_OUT_
( session ! I
, object ! I
, local-identifier ! O
, local-identifier-length ! O
, [ retain ] ) ; ! I