Synopsis
OMobj_id referencing_object,
OMobj_id referenced_object,
int mode );
int OMXobj::add_obj_ref(
OMobj_id referenced_object,
int mode = 0 );
Description
OMadd_obj_ref makes a connection in referencing_object to referenced_object .
OMadd_obj_ref is useful for both single connections and arrays of connections. For an array of connections, call OMadd_obj_ref multiple times, specifying the same referencing object each time and a different referenced object.
An error occurs if the referencing object is a scalar that is already connected to an object.
To replace or remove an object reference, call OMset_obj_ref instead. You can also use OMset_obj_ref to connect an object to a single other object.
For making special types of connections, call OMlink_objs.
Arguments
referencing_object
referenced_object
Object ids.
mode
The mode argument can specify the value OM_OBJ_REF_QUERY to obtain a status code that indicates whether or not the connection will be valid without actually making the connection. For normal operation, specify 0 for the mode.
Returned value
The status code (see See Return Status ).
See also