OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide

OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide—424822-001

2-1

The GPI Library

The GPI library procedural interface consists of 18 library procedures and four

declaration files. The library procedures allow the client program to manage objects,

transfer root objects, report errors, and control the gateway. The declaration files define

the procedures and their parameters.

This section provides a basic understanding of these GPI library components. The

topics covered are:

•

Library procedures

•

Environment management procedures

•

Object management procedures

•

Message transfer procedures

•

Declaration files

•

Data declaration files

•

Procedure declaration files

This section does not provide procedure call syntax or program examples. For

procedure call syntax, refer to the GPI Reference Manual. For program examples, refer

to the following sections and appendixes in this guide:

•

Section 5, Writing Your Program

•

Appendix A, TAL Program Example

•

Appendix B, C Program Example

Library Procedures

You can call the 18 library procedures from C or TAL client programs. The procedures

can be put into three groups, based on function: environment management procedures,

object management procedures, and message transfer procedures. Table 2-1

lists all the

GPI Library procedures.

Note that environment management procedures begin with the prefix GPI_ . Object

management and message transfer procedures begin with prefixes GPI_OM_ and

GPI_MT_ , respectively.

Table 2-1. GPI Library Procedures (page 1 of 2)

Environment

Management Object Management Message Transfer

GPI_INITIALIZE_ GPI_OM_CREATE_ GPI_MT_TRANSFER_OUT_

GPI_OPEN_ GPI_OM_INSERT_ GPI_MT_WAIT_

GPI_CLOSE_ GPI_OM_WRITE__ GPI_MT_START_TRANSFER_IN_