OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4-39
GPI_OM_READ_
On output, string-offset is the offset (in octets) of the start of the next string
segment to be read or 0 if the value contains no more segments to be read. You can
use the returned string-offset value in the next GPI_OM_READ_ call.
If the procedure call is unsuccessful, the parameter value is unchanged.
maximum-number input
INT(32):value
specifies the maximum number of octets to read. If the value of this parameter
exceeds the number of octets available, the number available is used.
To determine the total number of octets in the value without retrieving any octets,
specify 0 as the value of this parameter. The total number of octets in the value is
returned in the approx-total-number parameter.
data-string output
STRING .EXT:ref:*
specifies a buffer in your program’s memory space to which you want the segment
returned. The buffer must be long enough to contain the number of octets specified
by the maximum-number parameter.
If the procedure call is unsuccessful or the value of the maximum-number
parameter is 0, the buffer is unchanged.
actual-number output
INT(32) .EXT:ref:1
is the actual number of octets read. If the procedure call is unsuccessful, the
parameter is unchanged.
approx-total-number output
INT(32) .EXT:ref:1
is the total number of octets in the value. If the procedure call is unsuccessful, the
parameter is unchanged.
Consideration
•
You can also use this procedure to retrieve string values that are not long strings.