OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide

Writing Your Program
OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide—424822-001
5-41
Retrieving Information From a Root Object
Procedure call:
status := GPI_OM_EXAMINE_ (object_id,
values,
attribute_position,
maximum_number,
descriptor_list,
total_number,
actual_number,
string_buffer,
string_buffer_length,
actual_string_length,
total_string_length);
Inspecting Values of a Multivalued Attribute
You call the GPI_OM_LIST_ procedure to identify the values of a multivalued attribute.
You can limit the request to a specific number of values beginning at a specific position.
GPI_OM_LIST_ returns a list of descriptors for the attribute type you specify. Each
descriptor corresponds to one attribute value and contains a field for attribute type,
syntax, and value.
Parameters for GPI_OM_LIST_ are:
object (input)
attribute-type (input)
value-position (input)
maximum-number (input)
descriptor-list (output)
total-number (output)
actual-number (output; optional)
string-buffer (output; optional)
string-buffer-length (input; optional)
actual-string-length (output; optional)
total-string-length (output; optional)
object specifies the identifier of the object that contains the attribute whose values
you want to list.
attribute-type specifies the type of the attribute whose values you want to list.
value-position specifies the position within the attribute of the first value you
want to retrieve. The value of this parameter must be less than or equal to the value
position of the last value in the attribute.
maximum-number specifies the maximum number of descriptors to be returned. If
the value of this parameter exceeds the number of values available, the number available
is used.
Note. The GPI_OM_LIST_ procedure is the only way to retrieve the values of a multivalued
attribute.