DestroyCaret

2.x

  void DestroyCaret(void)    

The DestroyCaret function destroys the current caret shape, frees the caret from the window that currently owns it, and removes the caret from the screen if it is visible. The DestroyCaret function checks the ownership of the caret and destroys the caret only if a window in the current task owns it.

If the caret shape was previously a bitmap, DestroyCaret does not free the bitmap.

Parameters

This function has no parameters.

Return Value

This function does not return a value.

Comments

The caret is a shared resource. If a window has created a caret shape, it should destroy that shape before it loses the input focus or becomes inactive.

See Also

CreateCaret, HideCaret, ShowCaret