Synopsis
int OMget_ref_to_list(
OMobj_id object_id,
int *num_refs,
OMobj_id **ref_id_list,
int mode);
Description
This routine returns the list of objects that are connected to the object specified by object_id. This goes in the opposite direction from the OMget_num_refs and OMget_array_refs routines.
Arguments
object_id
The id of the object whose connections are returned.
num_refs
The number of connections to this object.
ref_id_list
A pointer to an array of object ids that are connected to this object. This list is allocated with the C malloc call and must be freed by you when you are done with the list.
mode
The mode in which this routine performs this operation:
|
Mode value
|
Behavior
|
|
0 |
Returns the ids of all objects that have names (i.e., are not intermediate link objects in the referencing chain to this object). |
|
OM_REF_TO_VALUE |
Returns the ids of intermediate name-link objects instead of returning just the objects that have names in the object hierarchy. You typically do not want to use this mode since these objects are usually safe to ignore. |
|
OM_REF_TO_SOURCE |
Skips to the end of a chain of connections. You often want to use this mode since it skips intermediate link objects. |
Returned value
A status code. See Return Status .