OSI/MHS P7 Application Programmatic Interface (P7 API) Manual

OSI/MHS P7 Application Programmatic Interface (P7 API) Manual—424825-001
vii
About This Manual
This manual describes the Compaq P7 Application Programmatic Interface (P7þAPI).
The P7þAPI provides a programmatic interface between a user agent (or client
application) and the Compaq Open Systems Interconnection/Message Handling System
(OSI/MHS) on the same system. The P7þAPI eliminates the need for client applications
to use the underlying OSI layers to reach the local OSI/MHS subsystem. The P7þAPI
connects to the local OSI/MHS subsystem at the message store (MS) boundary through
a programmatic interface.
This manual provides an overview of P7þAPI components and operation as well as
detailed descriptions of P7þAPI procedures and return codes used by client applications.
It also describes the basics of planning and writing a P7þAPI client application.
Who Should Read This Manual?
This manual is written for those who are writing client applications to interface to the
Compaq OSI/MHS subsystem. All readers should be experienced in using the C
language or the Compaq Transaction Application Language (TAL) and know how to
develop application programs to be run on a Compaq NonStop system. In addition, all
readers should be familiar with the Compaq OSI/MHS subsystem, basic Compaq
NonStop kernel architecture, and X.400 networks.
What’s in This Manual?
Here is a brief description of each section in the manual:
•
Section 1, “Introduction to the P7þAPI,” provides a brief overview of generic
application programmatic interfaces (APIs), the P7þAPI product, and P7þAPI
components.
•
Section 2, “Planning and Writing Your Application,” describes P7þAPI software
requirements, the factors that you must consider when planning your application, the
development of a P7þAPI program, and how the P7þAPI procedures work.
•
Section 3, “Procedure Calls,” provides the syntax of the procedure calls in the
P7þAPI library, along with considerations on their usage.
•
Appendix A, “DDL Definitions,” provides a brief description of the DDL data
structures that you can use in a P7 API client application.
•
Appendix B, “Return Codes,” describes the codes that provide error and status
information about a procedure call, and it suggests ways to recover from each error.
•
Appendix C, “Summary of the P7þAPI Procedure Calls for the C Language,”
provides a summary of the P7þAPI procedure calls as used in a C language program.
•
Appendix D, “Summary of the P7þAPI Procedure Calls for the TAL Language,”
provides a summary of the P7þAPI procedure calls as used in a TAL language
program.