Destroys an icon and frees any memory the icon occupied.

Syntax

BOOL DestroyIcon(      
    HICON hIcon
);

Parameters

hIcon

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

Return Value

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

It is only necessary to call DestroyIcon for icons and cursors created with the following functions: CreateIconFromResourceEx (if called without the LR_SHARED flag), CreateIconIndirect, and CopyIcon. Do not use this function to destroy a shared icon. A shared icon is valid as long as the module from which it was loaded remains in memory. The following functions obtain a shared icon.

• LoadIcon
• LoadImage (if you use the LR_SHARED flag)
• CopyImage (if you use the LR_COPYRETURNORG flag and the hImage parameter is a shared icon)
• CreateIconFromResource
• CreateIconFromResourceEx (if you use the LR_SHARED flag)

Function Information

Minimum DLL Version	user32.dll
Header	Declared in Winuser.h, include Windows.h
Import library	User32.lib
Minimum operating systems	Windows 95, Windows NT 3.1
Unicode	Implemented as Unicode version.

See Also

Icons Overview, CopyIcon, CreateIconFromResource, CreateIconFromResourceEx, CreateIconIndirect