HideCaret

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 removes the caret from the screen. Hiding a caret does not destroy its current shape or invalidate the insertion point.

BOOL
HideCaret(
HWND
hWnd
);

Parameters

hWnd

[in] Handle to the window that owns the caret. If this parameter is NULL, HideCaretsearches the current task for the window that owns the caret.

Return Values

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

Remarks

HideCarethides the caret only if the specified window owns the caret. If the specified window does not own the caret, HideCaretdoes nothing and returns FALSE.

Hiding is cumulative. If your application calls HideCaretfive times in a row, it must also call ShowCaretfive times before the caret is displayed.

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.