OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual522223-001
4-30
GPI_OM_FETCH_
GPI_OM_FETCH_
This procedure indicates whether specific attributes are present in an object. Optionally,
you can request the syntax and values of single-valued attributes that have a value
present.
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 about which you want information.
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:
descriptor-list-in input
STRING .EXT:ref:*
is a list of attribute descriptors specifying the types of attributes you want to fetch.
Each descriptor must specify an attribute type; the syntax and value fields are
ignored. For more information about descriptor lists, see Section 2, Information
Architecture and Data Structures.
status := GPI_OM_FETCH_ ( object ! I
, values ! I
, descriptor-list-in ! I
, descriptor-count ! I
, descriptor-list-out ! 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