OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Object Classes and Attribute Types
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3-117
IM-C-MESSAGE-BODY-PART
For the attribute IM-T-ISO-6937-TEXT, this value syntax is an alternative to OM-S-
OCTET-STRING.
When this attribute has the syntax OM-S-ONFILE-STRING, the GPI library stores
the value in a file, and the value retains the characteristics of its primary syntax.
For outbound messages, the client program should specify OM-S-ONFILE-STRING
as the syntax of an attribute when the memory storage space might be insufficient to
accommodate the value of the attribute. The client can specify this syntax for
specific strings when the accumulated length of the strings might overflow the total
string area specified in the max-table-data parameter of the GPI_INITIALIZE_
procedure call.
For inbound messages, the Gateway Interface Process automatically specifies OM-
S-ONFILE-STRING for those strings that exceed the value in the max-table-data
parameter of the GPI_INITIALIZE_ call or that exceed the maximum length
specified in the max-in-memory-string-len parameter of the
GPI_MT_START_TRANSFER_IN_ call.
Attributes that have the syntax OM-S-ONFILE-STRING are treated as long strings,
regardless of their actual length: that is, they are treated as if they were longer than
the specification of the max-string-len parameter of GPI_INITIALIZE_. Thus, you
can use only the procedure calls GPI_OM_READ_ and GPI_OM-WRITE_ to read
and write the values of strings that have the syntax OM-S-ONFILE-STRING.
IM-C-MESSAGE-BODY-PART
This class of object represents an IPM and, optionally, its delivery envelope. You can
use an object of this class to forward an IPM. The enclosing IPM is called the
forwarding IPM; the enclosed IPM is the forwarded IPM.
Table 3-72
describes the attribute types for this class and the syntax, length, and number
of values for each type.
Meanings of Attributes
The attribute types specify the following information:
Table 3-72. IM-C-MESSAGE-BODY-PART Attributes—General Characteristics
Attribute Type Value Syntax
Value
Length
Number of
Values
IM-T-ENVELOPE OM-S-OBJECT
(MH-C-DELIVERY-ENVELOPE)
- - 0-1
IM-T-IPM OM-S-OBJECT
(IM-C-INTERPERSONAL-MESSAGE)
- - 1
OM-T-CLASS OM-S-INTEGER - - 1