OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Information Architecture and Data Structures
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
2-10
String Segments
For more information about retrieving string values, see the procedure descriptions for
GPI_OM_EXAMINE_ on page 4-26, GPI_OM_FETCH_ on page 4-30,
GPI_OM_LIST_
on page 4-35, and GPI_OM_READ_ on page 4-38.
String Segments
When you call the GPI_INITIALIZE_ procedure at the beginning of your program, you
specify the maximum length for strings that can be processed by the
GPI_OM_EXAMINE_ , GPI_OM_FETCH_ , and GPI_OM_LIST_ procedures. A
string that is longer than the length you specify is called a long string and must be
retrieved by using the GPI_OM_READ_ procedure. Using this procedure, you can read
string segments in successive calls. You specify a string offset to indicate where you
want to begin reading and the maximum number of octets that you want to read.
Figure 2-6. Example of String Buffer
Descriptor List
GPI_OM_EXAMINE_
String Buffer
String Value
o
String Value
• • •
• • •
Descriptor
OM-S-xxx-STRING
Length, Elements
o
o
Descriptor
OM-S-xxx-STRING
(too long)
Descriptor
OM-S-xxx-STRING
Length, Elements
o
206VST .VSD