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.
A version of this page is also available for
4/8/2010

This function removes the caret from the screen. Hiding a caret does not destroy its current shape or invalidate the insertion point.

Syntax 

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 Value

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

Header winuser.h
Library Caret.lib
Windows Embedded CE Windows CE 1.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also