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

DspGetAnExtent

Gets the extent of the object (the enclosing boundary) at the specified AN.

Syntax

DspGetAnExtent(AN, Top, Left, Bottom, Right)

AN:

The AN at which the object is positioned.

Top:

A buffer that contains the top-most extent of the object.

Left:

A buffer that contains the left-most extent of the object.

Bottom:

A buffer that contains the bottom-most extent of the object.

Right:

A buffer that contains the right-most extent of the object.

Return Value

0 (zero) if successful, otherwise an error is returned. The Top, Left, Bottom, and Right arguments contain the extents of the object, in pixels.

Related Functions

DspGetAnWidth, DspGetAnHeight, DspGetAnLeft, DspGetAnRight, DspGetAnBottom, DspGetAnTop

Example

// Get extents at AN 25.
DspGetAnExtent(25, Top, Left, Bottom, Right);

See Also

Display Functions