DspAnGetArea

Cicode Programming Reference > Cicode Function Categories > Display Functions Introduction > DspAnGetArea

DspAnGetArea

Gets the area configured for an object at a specific AN (animation-point number). The area is returned as an integer.

Note: This function does not return the areas of keyboard commands associated with the object.

Syntax

DspAnGetArea(AN)

AN:

The animation-point number.

Return Value

The area if successful, otherwise an error is returned. If the object is configured with 'Same area as page' checked, the area of the page will be returned. AN area of 0 (zero) means no areas are configured for the object.

Related Functions

DspAnGetPrivilege

Example

/* Get the area configured for the object at AN60. /

DspAnGetArea(60);