DspAnGetPos | Display Functions

Cicode Programming Reference > Cicode Function Categories > Display Functions > DspAnGetPos

DspAnGetPos

Gets the x and y coordinates of an AN, in pixels, relative to the top-left corner of the window.

Syntax

DspAnGetPos(nAN, X, Y [, nMode])

nAN:

The animation-point number.

X, Y:

Variables used to store the x and y pixel coordinates of the AN, returned from this function.

nMode:

0 – (Default mode) Gets coordinates of an AN on the page. If the AN has not been displayed yet, e.g. default visibility state is hidden, (0, 0) is returned from calling the function.
1 – Gets coordinates of an AN from its configuration. i.e. page coordinates at which the object was originally inserted in Graphics Builder is returned from calling the function.

Return Value

0 (zero) if successful, otherwise an error is returned. The X and Y variables are set to the AN's position if successful, or to -1 if an error has been detected.

Related Functions

DspAnMove, DspAnInRgn, DspGetAnCur, DspGetMouse, DspGetNearestAn, PageTransformCoords

Example

/* Get the position of AN20 into X and Y. /
DspAnGetPos(20,X,Y);