ExtractIcon function

Retrieves a handle to an icon from the specified executable file, DLL, or icon file.

To retrieve an array of handles to large or small icons, use the ExtractIconEx function.

Syntax

HICON WINAPI ExtractIcon(
  _Reserved_ HINSTANCE hInst,
  _In_       LPCTSTR   lpszExeFileName,
  _In_       UINT      nIconIndex
);

Parameters

hInst

Type: HINSTANCE

A handle to the instance of the application calling the function.

lpszExeFileName [in]

Type: LPCTSTR

The name of an executable file, DLL, or icon file.

nIconIndex [in]

Type: UINT

The zero-based index of the icon to retrieve. For example, if this value is 0, the function returns a handle to the first icon in the specified file.

If this value is -1, the function returns the total number of icons in the specified file. If the file is an executable file or DLL, the return value is the number of RT_GROUP_ICON resources. If the file is an .ICO file, the return value is 1.

If this value is a negative number not equal to –1, the function returns a handle to the icon in the specified file whose resource identifier is equal to the absolute value of nIconIndex. For example, you should use –3 to extract the icon whose resource identifier is 3. To extract the icon whose resource identifier is 1, use the ExtractIconEx function.

Return value

Type: HICON

The return value is a handle to an icon. If the file specified was not an executable file, DLL, or icon file, the return is 1. If no icons were found in the file, the return value is NULL.

Remarks

You must destroy the icon handle returned by ExtractIcon by calling the DestroyIcon function.

Requirements

See also

Reference

DestroyIcon

Conceptual

Icons