SetCaretPos
A version of this page is also available for
4/8/2010
This function moves the caret to the specified coordinates.
Syntax
BOOL SetCaretPos(
int X,
int Y
);
Parameters
- X
[in] Integer that contains the new x-coordinate of the caret.
- Y
[in] Integer that contains the new y-coordinate of the caret.
Return Value
Nonzero indicates success. Zero indicates failure. To get extended error information, call GetLastError.
Remarks
SetCaretPos moves the caret whether or not the caret is hidden.
The system provides one caret per queue. A window should create a caret only when it has the keyboard focus or is active. The window should destroy the caret before losing the keyboard focus or becoming inactive. A window can set the caret position only if it owns the caret.
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 |