OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual

Procedure Calls
OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual—522223-001
4-40
GPI_OM_REMOVE_
GPI_OM_REMOVE_
This procedure removes and discards values of an attribute of an object. You cannot
remove values from a reserved object. You can use this procedure to remove either of
the following from an object:
•
One attribute value of a single-valued attribute
•
One or more attribute values of a multivalued attribute of the same attribute type
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 values you want to
remove.
attribute-type input
INT:value
specifies the type of the attribute whose values you want to remove.
value-position input
INT(32):value
specifies the position within the attribute of the first value you want to remove. The
value of this parameter must not be greater than that of the last value in the attribute
before you call the procedure.
maximum-number input
INT(32):value
specifies the maximum number of attribute values to be removed. If the maximum
number you specify exceeds the number of values in the attribute starting at
value-position, the value at value-position and all successive values are
removed.
status := GPI_OM_REMOVE_ ( object ! I
, attribute-type ! I
, value-position ! I
, maximum-number ! I
, total-number ! O