OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4-36
GPI_OM_LIST_
To determine the total number of values in the attribute without retrieving any
attribute descriptors, specify 0 as the value of this parameter. The total number of
values in the attribute is returned in the total-number parameter.
descriptor-list output
STRING .EXT:ref:*
is a buffer in your program’s memory space to which you want the attribute
descriptors returned. The area must be large enough to contain the number of
attribute descriptors specified by the maximum-number parameter.
The attribute descriptors are returned in the order in which the values appear in the
attribute. Each descriptor includes an attribute type, a syntax, and a value. If the
procedure call is unsuccessful or the value of the maximum-number parameter is
0, the buffer is unchanged.
For more information about descriptor lists, see Attribute Descriptors
on page 2-2.
total-number output
INT(32) .EXT:ref:1
is the total number of values in the attribute. This number is not affected by the
maximum-number or value-position parameter value. If the procedure call
is unsuccessful, the parameter is unchanged.
actual-number output
INT(32) .EXT:ref:1
is the actual number of attribute descriptors returned. If the procedure call is
unsuccessful, the parameter is unchanged.
string-buffer output
STRING .EXT:ref:*
is a buffer in your program’s memory space to which elements of any string values
are returned. This buffer can be in your program’s stack segment or in any extended
data segment. You must include this parameter if you specify a value greater than 0
for the string-buffer-length parameter.
string-buffer-length input
INT(32):value
specifies the maximum number of octets of string data that string-buffer can
contain. The minimum value you can specify is 0. You must specify this parameter
if you specify the string-buffer parameter.