OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls

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

4-5

Procedure Call Descriptions

Figure 4-2. Sample GPI Procedure Call Description (continued)

This line indicates whether the parameter is an input or an output parameter (or both).

This line indicates the parameter type, which begins with one of the following:

INT

INT(32)

STRING

Next, the following notation can appear:

.EXT

For all parameters except returned values, the parameter type (and .EXT, if present) is

followed by a colon. Additional information after the colon includes:

value

ref:1

ref:8

ref:32

ref:*

This line describes the information passed or returned in the parameter. When the

description includes a DDL name such as OM-TRUE, substitute an underscore for the

hyphen when you use the name in your program.

integer (one word)

doubleword integer

string

means that the parameter is a reference parameter accessed by an extended

pointer.

means that the actual value or contents of a parameter is passed.

means this is a reference parameter; that is, the address of the parameter is

passed. (The statements within the program body must access the actual

parameter contents indirectly through the parameter location.) “1” indicates

that the parameter contains one element.

indicates that the reference parameter contains 8 elements.

indicates that the reference parameter contains 32 elements.

indicates that the number of elements returned varies according to the

number of elements requested for the reference parameter.

401BVST .VSD