GETCARETPOSITION

Top  Previous  Next

Syntax

INT = GETCARETPOSITION(win as WINDOW,x as INT BYREF,y as INT BYREF)

Description

Retrieves the current caret position in the window.

Parameters

win - WINDOW containing the caret.

x, y - The current caret position is stored in these variables.

Return value

TRUE if the caret exists and is being displayed in a window. FALSE otherwise.

Remarks

The win parameter is not used by the function and can be passed an uninitialized WINDOW variable.  The variables x and y must be of type INT. The coordinates returned will always be in reference to the client area of the window containing the caret.

Example usage

DEF x,y AS INT
GETCARETPOSITION mywin, x, y