OMget_obj_ref_mode and OMset_obj_ref_mode


Synopsis



int  OMget_obj_ref_mode (
OMobj_id  object_id,
int  *reference_mode  );

int  OMset_obj_ref_mode (
OMobj_id  object_id,
int  reference_mode  );

Description

These routines get and set an object's reference mode.

Arguments

object_id

The id of an object.

reference_mode

In OMget_obj_ref_mode, an output argument containing the object's reference mode.

In OMset_obj_ref_mode, an input argument specifying the new mode.

reference_mode specifies the integer code for the mode. AVS/Express provides the following symbolic constants, defined in <avs/om.h>:

Mode

 

Meaning

 

OM_OBJ_VAL

By value mode (^)

OM_OBJ_REF

By reference mode (&)

OM_OBJ_PTR

By pointer mode (*)

 

Returned value

The status code (see Return Status ).

Example


/* Get object var1_id's reference mode. */
OMobj_id  var1_id;
int status;
int var1_ref_mode;
...
status = OMget_obj_ref_mode(var1_id, &var1_ref_mode);