OMFfind_obj

Synopsis

INTEGER FUNCTION OMFfind_obj(parent_id,
. name,
. mode,
. returned_id)
#include <avs/omf.inc>
INTEGER parent_id(OIDSIZ)
INTEGER name, mode
INTEGER returned_id(OIDSIZ)

Description

For a complete description of this function, see OMfind_obj.

Arguments

parent_id

The id of an object, as an integer value.

name

The unqualified name of an object as an Integer value.

mode

Indication of how the process intends to use the object. The following constants are predefined in the include file omf.inc :

Mode

Meaning

OM_OBJ_RD

The process intends to read the object, but not write to it (or any object that it might get using this id).

OM_OBJ_RW

The process intends to read and possibly write to the object.

The flags to qualify the object search are:

Flag

Meaning

OM_FIND_NO_LIBRARIES

Do not search recursively for subobjects in global libraries.

OM_FIND_NO_VIRTUAL

Do not search for virtual objects.

OM_SUB_TEMPL

If parent_id is a group pointer or reference, by default AVS/Express returns the id of parent_id 's subobject.OM_SUB_TEMPL specifies that AVS/Express should instead return the id of the subobject in parent_id 's template object.

returned_id

The id of the found object or OMnull_obj on failure

Returned value

1 on success; 0 if OMnull_obj is returned.

Examples

none.

See Also

OMFlookup_subobj

OMFfind_subobj