OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

DDL Definitions

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

A-5

Named Values

The following pages present named data values defined for use by application programs

when calling the GPI procedures. All syntax, object management, message handling,

and interpersonal messaging constants are taken from XAPIA-1988 specification unless

otherwise stated. Some constants have been abbreviated for this implementation.

Symbolic Constants

The GPI defines symbolic constants for Boolean values, parameter values, and

indicators.

OM-FALSE and OM-TRUE

These symbolic constants are used as Boolean values.

MH-xxx for GPI_MT_FINISH_TRANSFER_IN_

These symbolic constants define values for the remove parameter of the

GPI_MT_FINISH_TRANSFER_IN procedure.

For descriptions of these values, see GPI_MT_FINISH_TRANSFER_IN_

on page 4-10.

OM-ELEMENTS-UNSPECIFIED

This symbolic constant defines a value used in the LENGTH and ELEMENTS fields of

an attribute string value to indicate various conditions, as specified in the GPI procedure

descriptions in Section 4, Procedure Calls.

OM-POSITION-AT-END

This symbolic constant defines a value used to specify the position of an attribute value

in a descriptor list.

CONSTANT OM-FALSE TYPE BINARY 32 UNSIGNED VALUE IS 0.

CONSTANT OM-TRUE TYPE BINARY 32 UNSIGNED VALUE IS 1.

CONSTANT MH-CANCEL TYPE BINARY 32 UNSIGNED VALUE IS 0.

CONSTANT MH-REMOVE TYPE BINARY 32 UNSIGNED VALUE IS 1.

CONSTANT MH-ARCHIVE TYPE BINARY 32 UNSIGNED VALUE IS 2.

CONSTANT MH-TRANSFER TYPE BINARY 32 UNSIGNED VALUE IS 3.

CONSTANT OM-ELEMENTS-UNSPECIFIED TYPE BINARY 32 UNSIGNED

VALUE IS 0.

CONSTANT OM-POSITION-AT-END TYPE BINARY 32 VALUE IS -1.