GetCaretPos

Overview

Group

Quick Info

Windows NT
Yes
Win95
Yes
Win32s
Yes
Import Library
user32.lib
Header File
winuser.h
Unicode
No
Platform Notes
None

The GetCaretPos function copies the caret's position, in client coordinates, to the specified POINT structure.

BOOL GetCaretPos(

LPPOINT lpPoint	// address of structure to receive coordinates
);

Parameters
lpPoint

Points to the POINT structure that is to receive the client coordinates of the caret.

Return Values
If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks
The caret position is always given in the client coordinates of the window that contains the caret.