OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4-4
Procedure Call Descriptions
Figure 4-1. Sample GPI Procedure Call Description
4
3
2
1
status := GPI_OM_CREATE_ ( class
status returned value
INT:value
indicates the outcome of the call ...
class input
INT:value
is an integer that identifies ...
Legend
This indicates the type of value that the procedure returns. For the GPI
procedures, the variable name is always
status
. The
status
values returned are
from the list of MH-RC-, OM-RC-, and ZGPI-RC- status codes given in Appendix
B, “Return Codes.”
This is the name of the procedure. It must appear in the program exactly as
shown, including the underline characters. In a C program, all letters in the name
must be in uppercase.
You must enclose the list of parameters in parentheses. Use commas to
separat e multiple parameters. In the notation, optional parameters are enclosed in
square brackets ( [ and ] ); these brackets must not appear in the program. If you
omit optional parameters, a placeholder comma (,) must be present for each
omitted parameter, except for parameters omitted from the end of the list.
Some parameters are optional only if certain conditions are met. You should read
the parameter descriptions before omitting an optional parameter.
The exclamation point indicates that a comment follows. The comment is either an
I or an O (or both), indicating that the parameter is an input (I) or an output (O)
parameter, or both. Input parameters are those passing data to the called
procedure; output parameters are those that return data to the calling program.
7
6
5
4321
! I
! I
! 0
! I
! I
! I
! I
, initialize
, object
, [root-object]
, [session] ) ;
, [class-obj-id ]
, [class-obj-id-len ] ) ;
401VST .vsd