DestroyIcon function

Destroys an icon and frees any memory the icon occupied.

Syntax

BOOL DestroyIcon(
  HICON hIcon
);

Parameters

hIcon

Type: HICON

A handle to the icon to be destroyed. The icon must not be in use.

Return value

Type: BOOL

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.

Requirements

   
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header winuser.h (include Windows.h)
Library User32.lib
DLL User32.dll

See also

Conceptual

CopyIcon

CreateIconFromResource

CreateIconFromResourceEx

CreateIconIndirect

Icons

Reference