HideCaret

2.x

  void HideCaret(hwnd)    
  HWND hwnd; /* handle of window with caret */

The HideCaret function hides the caret by removing it from the screen. Although the caret is no longer visible, it can be displayed again by using the ShowCaret function. Hiding the caret does not destroy its current shape.

Parameters

hwnd

Identifies the window that owns the caret. This parameter can be set to NULL to specify indirectly the window in the current task that owns the caret.

Return Value

This function does not return a value.

Comments

The HideCaret function hides the caret only if the given window owns the caret. If the hwnd parameter is NULL, the function hides the caret only if a window in the current task owns the caret.

Hiding is cumulative. If HideCaret has been called five times in a row, ShowCaret must be called five times before the caret will be shown.

See Also

CreateCaret, ShowCaret