OMinsert_obj_ref


Synopsis


int  OMinsert_obj_ref (
OMobj_id  referencing_object,
int  index,
OMobj_id  referenced_object,
int mode  );

int OMXobj::insert_obj_ref(
int  index,
OMobj_id  referenced_object,
int mode = 0 );

Description

OMinsert_obj_ref inserts a connection referencing_object's list of connections to referenced_object at the location specified by index. This routine is similar to OMadd_obj_ref but provides control over the order of execution.

OMinsert_obj_ref is useful when operating on an object that has an array of connections where the order of the connection list is important.

For making special types of connections, call OMinsert_link_objs.

Arguments

referencing_object
referenced_object

Object ids.

index

The index into the array of connections.

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 Return Status ).

See Also

•      OMadd_obj_ref

•      OMlink_objs