OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls

OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001

4-13

GPI_MT_START_TRANSFER_IN_

This procedure reserves an object in the input queue and makes that object available to

your client application. The object can be a message, probe, report, or a P1-encoded

PDU. You can examine but not modify the reserved object.

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 an established session in which the request for

access to an object is made.

object output

INT(32) .EXT:ref:1

is an object identifier assigned to the object reserved by this procedure. If no object

is available to be reserved, the value of this parameter is ZGPI-NULL-OBJ-ID (0).

encoded input

INT(32)

is a value that specifies whether an encoded or decoded object is returned. If the

parameter is not present, a value of OM-FALSE is assumed. (See below for the

definition of OM-FALSE.) The values for encoded can be as follows:

If you omit this parameter, the default value is OM-FALSE.

status := GPI_MT_START_TRANSFER_IN_ (

session ! I

, object ) ; ! O

, [ encoded ] ! I

, [ tag ] ! I

, [ max-in-memory-string-len ]); ! I

OM-TRUE specifies that the object is to be to be passed to the client applica-

tion as an encoded PDU.

OM-FALSE specifies that the PDU is to be passed to the client application in

the normal decoded object-tree form of a message.