OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls

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

4-3

Procedure Call Descriptions

Figure 4-1 shows the notation used to describe procedure calls in this manual. The

syntax of the call is enclosed in a box. Below the box, a description of each parameter is

given.

This notation gives the syntax for calling the procedures from TAL programs. For

information about using the TAL language, refer to the Transaction Application

Language (TAL) Reference Manual. You can also call these procedures from

C programs; for a summary of the GPI procedure calls for the C language, refer to

Appendix C, GPI Procedure Calls for the C Language

. For additional information on

using the C language, refer to the C Reference Manual.

Following Figure 4-1

, the remainder of this section provides the syntax and semantics of

all the GPI procedures, in alphabetic order.

When you provide values by referring to DDL names such as OM-TRUE, substitute an

underscore for each hyphen: for example, OM_TRUE.

Table 4-3. GPI Message Transfer Procedures

Procedure Name Purpose

GPI_MT_FINISH_TRANSFER_IN_ Changes the state of a reserved object by either

removing it permanently from the GPI service’s

input queue, moving it from the input queue to the

archive queue, making it unreserved and leaving it

in the input queue, or removing it from the input

queue and resubmitting it to the MTA.

GPI_MT_START_TRANSFER_IN_ Reserves an object in the input queue of the GPI

service and makes it available to your program for

examining and copying.

GPI_MT_TRANSFER_OUT_ Adds a message, probe, report, or P1-encoded

object to the output queue of the GPI service.

GPI_MT_WAIT_ Monitors the input queue of the GPI service for a

specified time, checking for available unreserved

objects.

Note. The condition code, a hardware register that can be set by software, is not meaningful

after a call to a GPI procedure.