Función ExtractIconA (shellapi.h)

Obtiene un identificador de un icono del archivo ejecutable, dll o archivo de icono especificado.

Para recuperar una matriz de identificadores a iconos grandes o pequeños, use la función ExtractIconEx .

Sintaxis

HICON ExtractIconA(
  [in] HINSTANCE hInst,
  [in] LPCSTR    pszExeFileName,
       UINT      nIconIndex
);

Parámetros

[in] hInst

Tipo: HINSTANCE

Controle a la instancia de la aplicación que llama a la función .

[in] pszExeFileName

Tipo: LPCTSTR

Puntero a una cadena terminada en null que especifica el nombre de un archivo ejecutable, un archivo DLL o un archivo de icono.

nIconIndex

Tipo: UINT

Especifica el índice de base cero del icono que se va a recuperar. Por ejemplo, si este valor es 0, la función devuelve un identificador al primer icono del archivo especificado.

Si este valor es -1, la función devuelve el número total de iconos del archivo especificado. Si el archivo es un archivo ejecutable o DLL, el valor devuelto es el número de recursos de RT_GROUP_ICON. Si el archivo es . El archivo ICO, el valor devuelto es 1.

Si este valor es un número negativo no igual a –1, la función devuelve un identificador al icono del archivo especificado cuyo identificador de recurso es igual al valor absoluto de nIconIndex. Por ejemplo, debe usar –3 para extraer el icono cuyo identificador de recurso es 3. Para extraer el icono cuyo identificador de recurso es 1, use la función ExtractIconEx .

Valor devuelto

Tipo: HICON

El valor devuelto es un identificador de un icono. Si el archivo especificado no era un archivo ejecutable, dll o archivo de icono, la devolución es 1. Si no se encontraron iconos en el archivo, el valor devuelto es NULL.

Comentarios

Cuando ya no sea necesario, debe destruir el identificador de icono devuelto por ExtractIcon llamando a la función DestroyIcon .

Nota

El encabezado shellapi.h define ExtractIcon como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.

Requisitos

Requisito Value
Cliente mínimo compatible Windows XP [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino Windows
Encabezado shellapi.h
Archivo DLL Shell32.dll
Conjunto de API ext-ms-win-shell-shell32-l1-2-1 (introducido en Windows 10, versión 10.0.10240)

Consulte también

ExtractAssociatedIcon

ExtractAssociatedIconEx

ExtractIconEx