HideCaret function

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

Syntax


BOOL WINAPI HideCaret(
  _In_opt_  HWND hWnd
);

Parameters

hWnd [in, optional]

Type: HWND

A handle to the window that owns the caret. If this parameter is NULL, HideCaret searches the current task for the window that owns the caret.

Return value

Type: BOOL

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

Remarks

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

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

For an example, see Hiding a Caret.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Winuser.h (include Windows.h)

Library

User32.lib

DLL

User32.dll

See also

Reference
CreateCaret
DestroyCaret
GetCaretPos
SetCaretPos
ShowCaret
Conceptual
Carets

 

 

Community Additions

ADD
Show:
© 2014 Microsoft