ExtractIconExA function

The ExtractIconEx function creates an array of handles to large or small icons extracted from the specified executable file, DLL, or icon file.

Syntax

UINT ExtractIconExA(
  LPCSTR lpszFile,
  int    nIconIndex,
  HICON  *phiconLarge,
  HICON  *phiconSmall,
  UINT   nIcons
);

Parameters

lpszFile

Type: LPCTSTR

Pointer to a null-terminated string that specifies the name of an executable file, DLL, or icon file from which icons will be extracted.

nIconIndex

Type: int

Specifies the zero-based index of the first icon to extract. For example, if this value is zero, the function extracts the first icon in the specified file.

If this value is –1 and phiconLarge and phiconSmall are both NULL, 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 and either phiconLarge or phiconSmall is not NULL, the function begins by extracting the icon whose resource identifier is equal to the absolute value of nIconIndex. For example, use -3 to extract the icon whose resource identifier is 3.

phiconLarge

Type: HICON*

Pointer to an array of icon handles that receives handles to the large icons extracted from the file. If this parameter is NULL, no large icons are extracted from the file.

phiconSmall

Type: HICON*

Pointer to an array of icon handles that receives handles to the small icons extracted from the file. If this parameter is NULL, no small icons are extracted from the file.

nIcons

Type: UINT

The number of icons to extract from the file.

Return Value

Type: UINT

If the nIconIndex parameter is -1, the phiconLarge parameter is NULL, and the phiconSmall parameter is NULL, then the return value is the number of icons contained in the specified file. Otherwise, the return value is the number of icons successfully extracted from the file.

Remarks

When they are no longer needed, you must destroy all icons extracted by ExtractIconEx by calling the DestroyIcon function.

To retrieve the dimensions of the large and small icons, use this function with the SM_CXICON, SM_CYICON, SM_CXSMICON, and SM_CYSMICON flags.

Requirements

   
Windows version Windows XP [desktop apps only] Windows 2000 Server [desktop apps only]
Target Platform Windows
Header shellapi.h
DLL Shell32.dll

See Also

ExtractAssociatedIcon

ExtractAssociatedIconEx

ExtractIcon