Windows Dev Center

DestroyCaret function

Destroys the caret's current shape, frees the caret from the window, and removes the caret from the screen.

Syntax


BOOL WINAPI DestroyCaret(void);

Parameters

This function has no parameters.

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

DestroyCaret destroys the caret only if a window in the current task owns the caret. If a window that is not in the current task owns the caret, DestroyCaret does nothing and returns FALSE.

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.

For an example, see Destroying 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
HideCaret
ShowCaret
Conceptual
Carets

 

 

Community Additions

ADD
Show:
© 2015 Microsoft