DestroyCursor

The DestroyCursor function destroys a cursor and frees any memory the cursor occupied. Do not use this function to destroy a shared cursor.

BOOL DestroyCursor(
  HCURSOR hCursor   // handle to cursor to destroy
);
 

Parameters

hCursor

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

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

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)

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in winuser.h.
  Import Library: Use user32.lib.

See Also

Cursors Overview, Cursor Functions, CopyCursor, CopyImage, CreateCursor, LoadCursor, LoadCursorFromFile, LoadImage