Function:
DestroyCaret()

 

Description:
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.

 

Parameters:
No parameters.

 

Returns:
If the function succeeds, the return value is nonzero. If the function fails, the return value is zero.

 

Example:
Select the icon to download the sample caret.a5p. This file demonstrates various caret functions to display a blinking cursor on screen.