OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Object Classes and Attribute Types
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
3-121
IM-C-NAT-DEFINED-BODY-PART
Table 3-77 describes the attribute types for this class and the syntax, length, and number
of values for each type.
Meanings of Attributes
The first attribute type specifies the following information:
IM-T-NATIONAL-DATA
Is the binary data, which must follow the BER, except the minimum length is 2 octets.
You can specify a zero-length octet string as hexadecimal ‘04 00’.
Implementation and Usage Note
•
Use of this class is discouraged and intended only for domestic communication in
which the country is implicitly that of the originator and all of the recipients of the
IPM that contains the nationally defined body part.
•
OM-S-ONFILE-STRING is a value syntax that applies to messages exceeding 64
kilobytes.
For the attribute IM-T-NATIONAL-DATA, 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.
Table 3-77. IM-C-NAT-DEFINED-BODY-PART Attributes—General
Characteristics
Attribute Type Value Syntax
Value
Length
Number of
Values
IM-T-NATIONAL-DATA OM-S-OCTET-STRING
or
OM-S-ONFILE-STRING
2-n 1
OM-T-CLASS OM-S-INTEGER - - 1