OMset_obj_ref

Synopsis

int OMset_obj_ref (OMobj_id referencing_object,
OMobj_id referenced_object,int mode );
int OMXobj::set_obj_ref (OMobj_id referenced_object,
int mode = 0);

Description

OMset_obj_ref makes a connection in referencing_object to referenced_object .OMset_obj_ref is useful for making a single connection. If the referencing object is already connected to an object, that connection is replaced by the new connection.If the referencing object is a scalar, the referenced object must also be a scalar. If the referencing object is an array, the referenced object must also be an array.To connect an object to an array of objects, call OMadd_obj_ref instead.

Arguments

referencing_object

The id of the referencing object.

referenced_object

The id of the referenced object.You can specify OMnull_obj. The Object Manager simply breaks the current connection so that referencing_object is no longer connected to anything.

mode

The mode argument is typically specified as 0. If you specify a mode argument of OM_OBJ_REF_RDONLY, you create a read-only connection. For primitive values, a read-only connection is broken whenever a set operation applied to the referencing object.

Returned value

The status code (see Return Status ).

Examples

none.

See Also

none.