OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls

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

4-42

GPI_OM_WRITE_

This procedure writes a segment of a string value to a specified type of attribute. A

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

representation. Typically, this procedure is used to add to an attribute value an arbitrarily

long value, such as a noninterpersonal message content or large body part. You can use

this procedure to write a new string value, append a string segment to an existing value,

or replace all or part of a string value.

You should call this procedure as many times as needed to add all segments of the value.

Each call returns a next position, which you can use as the starting position (string

offset) for the next call.

You cannot write segments to a reserved object.

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 containing the attribute to which you

want to write.

attribute-type input

INT:value

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

value-position input

INT(32):value

specifies the position within the attribute of the value you want to write. For an

explanation of how to specify value-position, see the considerations that

follow the parameter descriptions.

status := GPI_OM_WRITE_ ( object ! I

, attribute-type ! I

, value-position ! I

, string-offset ! I/O

, data-string ! I

, element-number ! I

, [ syntax ] ) ; ! I