ShowCaret

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 makes the caret visible on the screen at the caret's current position. When the caret becomes visible, it begins flashing automatically.

BOOL
ShowCaret(
HWND
hWnd
);

Parameters

hWnd

[in] Handle to the window that owns the caret. If this parameter is NULL, ShowCaretsearches 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

ShowCaretshows the caret if the specified window owns the caret and the caret has a shape. If either of these conditions is not met, ShowCaretdisplays nothing and returns zero. If the caret has been hidden two or more times in a row, ShowCaretdisplays nothing, but returns a nonzero value.

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

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.

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.