OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4-27
GPI_OM_EXAMINE_
maximum-number input
INT(32):value
specifies the number of attribute descriptors to be returned. If the value of this
parameter exceeds the number of attributes available, the number available is used.
The maximum value for this parameter is ZGPI-MAX-DESCRIPTOR-COUNT
(10,240).
To determine the total number of attributes in the object without retrieving any
attribute descriptors, specify 0 as the value of this parameter. The total number of
attributes in the object is returned through 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 they appear in the object.
Each descriptor includes an attribute type. If the attribute is single-valued and you
specify OM-TRUE for the values parameter, a syntax and value are returned. 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 Section 2, Information Architecture
and Data Structures.
total-number output
INT(32) .EXT:ref:1
is the total number of attributes present in the object (including the OM-T-CLASS
attribute). This number is not affected by the attribute-position or
maximum-number 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
of the attributes are returned. This buffer can be in your program’s stack segment or
in any extended data segment. For a description of string buffers, see Section 2,
Information Architecture and Data Structures.