This function destroys the caret's current shape, frees the caret from the window, and removes the caret from the screen.
At a Glance
| Header file: | Winuser.h |
| Windows CE versions: | 1.0 and later |
Syntax
BOOL DestroyCaret(void);
Return Values
The return value of this function does not indicate whether the function was successful or not.
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.
See Also