OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Information Architecture and Data Structures
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual522223-001
2-3
Types
The syntax is represented by the DDL constant OM-S-BOOLEAN, which is a 16-bit
integer value of 1.
The value is represented by the DDL constant OM-TRUE, which is a 32-bit integer
value of 1. The DDL structure for a descriptor defines a 64-bit field for the value, so
the last 32-bit field is undefined in this case.
For descriptions of more descriptors, see Data Structures
on page 2-5.
If you request attributes of an object by calling the GPI_OM_EXAMINE_ or
GPI_OM_FETCH_ procedure, the type or syntax might be invalid or unspecified. Your
program must check the descriptor to determine whether it contains valid information.
For more information, see Section 4, Procedure Calls
.
A single-valued attribute has only one value; a multivalued attribute has multiple
values. For example, the originator name attribute of a message is single-valued but the
recipient-descriptors attribute is multivalued (it can include several message-recipient-
descriptor objects as values).
A descriptor can include only one value. To specify values for multivalued attributes,
you must provide a descriptor for each value. Each descriptor has the same type and
syntax but the values are typically different.
Types
Each attribute type is represented by an integer. DDL constant names for types
available through the GPI begin with the following prefixes:
For example, the type of the priority attribute of an MH message is MH-T-PRIORITY,
and the type of the originator attribute of an IM message is IM-T-ORIGINATOR. The
Figure 2-1. Example of Attribute Descriptor
MH-T- Types of the message handling (MH) attributes
IM-T- Types of the interpersonal messaging (IM) attributes
OM-T- Types of the object management (OM) attributes
EDI-T- Types of the electronic data interchange (EDI) attributes
Type Syntax Value
MH-T-B4-WIDTH OM-S-BOOLEAN OM-TRUE
(16 Bits) (16 Bits) (32 Bits) (32 Bits)
215 1 1 ——
201VST .VSD