DestroyCaret
The DestroyCaret
function destroys the caret s current shape, frees the caret from the window,
and removes the caret from the screen.
If the caret
shape is based on a bitmap, DestroyCaret does not free the bitmap.
BOOL DestroyCaret(VOID)
Parameters
This function
has no parameters.
Return Values
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 caret is
a shared resource; there is only one caret in the system. 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