OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4-31
GPI_OM_FETCH_
descriptor-count input
INT(32):value
specifies the number of attribute descriptors you are supplying. The minimum value
for this parameter is ZGPI-MIN-DESCRIPTOR-COUNT (1). The maximum value
for this parameter is ZGPI-MAX-DESCRIPTOR-COUNT (10,240).
descriptor-list-out 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 descriptor-count parameter.
The attribute descriptors appear in the order that you specify the types in
descriptor-list-in. Each descriptor includes a type if an attribute of that
type is present in the object; otherwise, the type returned is OM-T-UNSPECIFIED.
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, the
buffer is unchanged.
string-buffer output
STRING .EXT:ref:*
is a buffer in your program’s memory space to which any string values of the
attributes are returned. This buffer can be in your program’s stack segment or in any
extended data segment. You must include this parameter if you specify a value
greater than 0 for the string-buffer-length parameter.
string-buffer-length input
INT(32):value
specifies the maximum number of octets of string data that string-buffer can
contain. The minimum value you can specify is 0. You must specify this parameter
if you specify the string-buffer parameter.
actual-string-length output
INT(32) .EXT:ref:1
is the actual number of octets of string data returned. If the procedure call is
unsuccessful, the parameter is unchanged.
total-string-length output
INT(32) .EXT:ref:1
is the total number of octets of string data available in the attribute descriptors of the
attributes you requested.