OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls

OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001

4-38

GPI_OM_READ_

This procedure reads a segment of a long string value of a specified type of attribute. A

segment is a portion of a string made up of zero or more contiguous octets of its

representation. You should call this procedure as many times as needed to read all

segments of the value. Each call returns a next position, which you can use as the

starting position for the next call.

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 whose attribute value you want to read.

attribute-type input

INT:value

specifies the type of the attribute whose value you want to read.

value-position input

INT(32):value

specifies the position within the attribute of the value you want to read. The value of

this parameter must not be greater than that of the last value in the attribute.

string-offset input, output

INT(32) .EXT:ref:1

on input, specifies the offset (in octets) of the start of the string element to be read.

The offset of the first octet in a string is 0. The value of this parameter must be less

than the actual number of octets in the attribute’s value. This parameter is not

checked if maximum-number is zero.

status := GPI_OM_READ_ ( object ! I

, attribute-type ! I

, value-position ! I

, string-offset ! I/O

, maximum-number ! I

, [ data-string ] ! O

, [ actual-number ] ! O

, approx-total-number ) ; ! O