OMget_obj_att and OMset_obj_att


Synopsis


int  OMget_obj_att (
OMobj_id  object_id,
OMobj_name  attribute,
int  *state  );

int  OMset_obj_att (
OMobj_id  object_id,
OMobj_name  attribute,
int  state  );

Description

These routines get and set an object's attribute.

Arguments

object_id

The id of an object.

attribute

The name of an attribute. You can specify any of the following variables, which are defined in <avs/om_att.h>:

Attribute

 

Meaning

 

OM_att_nosave

Do not save the object. Do not write it in a $print command.

OM_att_req

Make the object required. The object's associated function object will execute only if the object has a valid value.

OM_att_virtual

Make the object virtual.

OM_att_read

Method reads this parameter.

OM_att_noread

Method does not read this parameter.

OM_att_write

Method writes this parameter.

OM_att_nowrite

Method does not write this parameter.

OM_att_notify

Method notifies this parameter.

OM_att_nonotify

Method does not notify this parameter.

 

state

In OMget_obj_att, an output argument containing the attribute's state.

In OMset_obj_att, an input argument specifying the new state.

The state is one of the following:

State

 

Meaning

 

1

The attribute is set.

0

The attribute is not set.

 

Returned value

The status code (see Return Status ).

Example


/* Flip object grp1_id's notify state. */
#include <avs/OM_att.h>
OMobj_id grp1_id;
int state;
int status;
...
status = OMget_obj_att(grp1_id, OM_att_notify, &state);
state = !state;
status = OMset_obj_att(grp1_id, OM_att_notify, state);