GetCaretPos
A version of this page is also available for
4/8/2010
This function copies the caret's position, in client coordinates, to the specified POINT structure.
Syntax
BOOL GetCaretPos(
LPPOINT lpPoint
);
Parameters
- lpPoint
[out] Long pointer to the POINT structure that is to receive the client coordinates of the caret.
Return Value
Nonzero indicates success. Zero indicates failure. 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.
If an application calls GetCaretPos from a thread that does not own the caret, GetCaretPos fails with an error value of ERROR_ACCESS_DENIED.
Requirements
| Header | winuser.h |
| Library | Caret.lib |
| Windows Embedded CE | Windows CE 1.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |