$collhandle

Return the handle of the requested entity.

Synopsis

$collhandle{(LitEntityName)}

Use

Allowed in all component types.

Description

The function $collhandle returns the handle of the requested entity.

If the LitEntityName argument is provided, it must be one of the following:

• The literal name of an entity painted on the component. For example, $collhandle("MYENTITY").

• A string that evaluates to the name of an entity. For example, $collhandle("MYENTITY").
• A variable, function, or parameter that evaluates to a string that contains the name of an entity. For example:
• $collhandle ($1), where $1 contains "MYENTITY".
• $collhandle (PARAM1), where PARAM1 contains "MYENTITY".
• $collhandle ($entname), where $entname is "MYENTITY".
• An indirect reference to a field, where the target field evaluates to a string that contains the name of an instance. For example, $collhandle (@$1), where $1 contains "FLD1" and FLD1 contains "MYENTITY".

If the LitEntityName argument is omitted, the current entity is used.

Return value

The function $collhandle returns the handle of the entity of LitEntityName.

An null handle is returned if an error occurred or if LitEntityName is not a correct entity.

If an error occurs during the evaluation of this function, the function $procerror contains a negative value that identifies the exact error. Values of $procerror commonly returned by this function are:

Related Information

$occhandle

$instancehandle