DestroyCaret
A version of this page is also available for
4/8/2010
This function destroys the caret's current shape, frees the caret from the window, and removes the caret from the screen.
Syntax
BOOL DestroyCaret(void);
Parameters
None.
Return Value
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.
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 |