Microsoft Windows CE 3.0  

GetCaretPos

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 copies the caret's position, in client coordinates, to the specified POINTstructure.

BOOL
GetCaretPos(
LPPOINT
lpPoint
);

Parameters

lpPoint
[out] Long pointer to the POINTstructure that is to receive the client coordinates of the caret.

Return Values

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 GetCaretPosfrom a thread that does not own the caret, GetCaretPosfails with an error value of ERROR_ACCESS_DENIED.

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

SetCaretPos, POINT