DestroyCursor

This function destroys a cursor created by the CreateCursor function and frees any memory the cursor occupied. Do not use this function to destroy a cursor that was not created with the CreateCursor function.

At a Glance

Syntax

BOOL DestroyCursor( HCURSOR hCursor );

Parameters

hCursor

[in] Handle to the cursor to be destroyed. The cursor must not be in use.

Return Values

Nonzero indicates success. Zero indicates failure. To get extended error information, call GetLastError.

Remarks

The DestroyCursor function destroys a non-shared cursor. Do not use this function to destroy a shared cursor. A shared cursor is valid as long as the module from which it was loaded remains in memory. The following functions obtain a shared cursor:

• LoadCursor
  
  
• LoadCursorFromFile
  
  
• LoadImage (if you use the LR_SHARED flag)
  
  
• CopyImage (if you use the LR_COPYRETURNORG flag and the hImage parameter is a shared cursor)

See Also

CreateCursor