OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4-43
GPI_OM_WRITE_
string-offset input, output
INT(32) .EXT:ref:1
on input, specifies how a string is to be written, as follows:
•
A string offset of ZGPI-NEW-VALUE (-1) specifies that you are adding or
inserting a new string value as specified by the value-position parameter.
•
A string offset equal to or greater than 0 specifies that you are appending a
string segment to an existing value and possibly overwriting existing octets in
the string. The segment is appended as specified by the value-position
parameter.
The minimum string offset allowed is ZGPI-NEW-VALUE. The string offset
cannot exceed the current length of the existing string value. The string offset
plus the length of the string segment you are adding cannot exceed the
maximum length string allowed for a value of the specified attribute.
For an explanation of how to specify string-offset, see the considerations that
follow the parameter descriptions.
On output, string-offset is the offset (in octets) after the last string segment
written. You can use the returned string-offset as the starting position in the
next GPI_OM_WRITE_ call.
If the procedure call is unsuccessful, the parameter value is unchanged.
data-string input
STRING .EXT:ref:*
specifies a buffer in your program’s memory space that contains the string segment
to be written. This segment will be copied to the string value starting at the offset
specified by string-offset. The number of octets written will be equal to the
value of the element-number parameter.
element-number input
INT(32):value
specifies the number of octets to be written; the minimum value is 0. The maximum
value is the smaller of the attribute’s value length or the value specified for the
GPI_INITIALIZE_ max-table-data parameter.
syntax input
INT:value
specifies the syntax to be used for a value of an attribute that is not already present
in the object. You must specify a valid string syntax of the form OM-S-xxx-
STRING. This parameter is ignored if the value already exists. For information on
the value syntax OM-S-ONFILE-STRING, see “Considerations” at the end of this
section.