OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4-35
GPI_OM_LIST_
GPI_OM_LIST_
This procedure retrieves the values of a multivalued attribute of an object. The
procedure returns a single attribute descriptor for each value. You can limit the request
to a specific number of values, beginning at a specific position. This is the only way to
retrieve the values of a multivalued attribute.
status returned value
INT:value
indicates the outcome of the call. A value of OM-RC-SUCCESS indicates a
successful call. For additional values of status, see Appendix B, Return Codes
.
object input
INT(32):value
specifies the object identifier of the object you want information about.
attribute-type input
INT(32):value
specifies the type of the attribute whose values you are retrieving.
value-position input
INT(32):value
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 input
INT(32):value
specifies the maximum number of attribute descriptors to be returned. If the value of
this parameter exceeds the number of values available, the number available is used.
The maximum value for this parameter is ZGPI-MAX-DESCRIPTOR-COUNT
(10,240).
status := GPI_OM_LIST_ ( object ! I
, attribute-type ! I
, value-position ! I
, maximum-number ! I
, descriptor-list ! O
, total-number ! O
, [ actual-number ] ! O
, [ string-buffer ] ! O
, [ string-buffer-length ] ! I
, [ actual-string-length ] ! O
, [ total-string-length ] ) ; ! O