OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4-33
GPI_OM_INSERT_
GPI_OM_INSERT_
This procedure adds attribute values to an object. You cannot add values to a reserved
object. A single call to this procedure can either insert a list of single-valued attributes or
a list of multivalued attributes of the same type, or both.
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 to which attribute values are being added.
value-position input
INT(32):value
specifies the position within the attribute at which the first new value is to be
inserted. If you specify OM-POSITION-AT-END, or you specify a position that is
not within the range of current positions for the attribute, the first new value is
added immediately after any existing values. For single-valued attributes, this
parameter is ignored.
descriptor-list input
STRING .EXT:ref:*
is the list of attribute descriptors to be processed. For more information about
descriptor lists, see Section 2, Information Architecture and Data Structures
.
descriptor-count input
INT(32):value
specifies the number of attribute descriptors to be processed. 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).
Considerations
•
GPI_OM_INSERT_ verifies the integrity and validity of attribute types, syntaxes,
and values before adding them. The type specified in each attribute descriptor must
be one of the types defined for the object’s class. The syntax must be valid for the
status := GPI_OM_INSERT_ ( object ! I
, value-position ! I
, descriptor-list ! I
, descriptor-count ) ; ! I