Microsoft Windows CE 3.0  

SetCaretPos

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

This function moves the caret to the specified coordinates.

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 Values

Nonzero indicates success. Zero indicates failure. To get extended error information, call GetLastError.

Remarks

SetCaretPosmoves 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

Runs On Versions Defined in Include Link to
Windows CE OS 1.0 and later Winuser.h   Caret.lib
Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

GetCaretPos, HideCaret, ShowCaret