OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
xxvii
About This Manual
This manual describes the Compaq OSI/MHS Gateway Programmatic Interface (GPI),
which is the Compaq implementation of the X.400 Gateway Application Program
Interface (X.400 API). The GPI provides a programmatic interface to the Compaq Open
Systems Interconnection/Message Handling System (OSI/MHS) at the message transfer
agent (MTA) boundary. The manual provides formal, detailed descriptions of the
language architecture, procedure syntax, return codes, and Data Definition Language
(DDL) structures and constants used by the GPI.
Who Should Read This Manual?
Application programmers who are writing gateway interface programs should use this
manual to obtain reference information about the GPI. All readers should be
experienced in using the Compaq Transaction Application Language (TAL) or the
C programming language and know how to develop application programs to be run on a
Compaq NonStop™ system. Readers should also have some understanding of X.400
networks and the Compaq OSI/MHS subsystem.
What’s in This Manual?
•
Section 1, Introduction to the GPI, provides a brief overview of the GPI and its
relation to the Compaq OSI/MHS subsystem and introduces some important
concepts that affect the programs you develop.
•
Section 2, Information Architecture and Data Structures, describes an object-based
structure used to create and interpret messages, probes, and reports that are
transferred to or from an X.400 network through the GPI service. This section also
describes data structures such as attribute descriptors and string buffers, which you
use when requesting GPI services through procedure calls.
•
Section 3, Object Classes and Attribute Types, describes the purpose and
characteristics of object classes and their attributes.
•
Section 4, Procedure Calls, provides the syntax and semantics of the procedure calls
in the GPI library.
•
Appendix A, DDL Definitions, provides a summary of the DDL definitions used by
the GPI except those related to status information, which are described in
Appendix B.
•
Appendix B, Return Codes, describes the codes that provide status and error
information about a procedure call, explains how to retrieve additional information,
and suggests ways to recover from errors.
•
Appendix C, GPI Procedure Calls for the C Language, provides a summary of the
GPI procedure calls as used in a C language program.
•
Appendix D, Class Hierarchies, provides an overview—in diagrams—of the
structure of object classes.