OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4-26
GPI_OM_EXAMINE_
GPI_OM_EXAMINE_
This procedure informs you about the types of single-valued and multivalued attributes
of an object and, optionally, the syntax and values of single-valued attributes that have a
value present. You can request the attribute descriptors of one or more attributes
beginning at a specified attribute position.
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 being examined.
values input
INT(32):value
specifies whether the value and syntax of any single-valued attributes should be
returned.
The value of this parameter can be:
attribute-position input
INT(32):value
specifies the position within the object of the first attribute you want to examine.
The first attribute in the object is at position ZGPI-POSITION-AT-BEGIN, which
is 0. The value of this parameter must be less than the number of attributes in the
object; that is, the specified position must be within the range of attribute positions
for the object.
status := GPI_OM_EXAMINE_ ( object ! I
, values ! I
, attribute-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
OM-TRUE requests return of the syntax and value.
OM-FALSE requests return of the attribute type only.