Función PrivateExtractIconsA (winuser.h)

Artículo
03/15/2023

[Esta función no está pensada para uso general. Puede modificarse o no estar disponible en versiones posteriores de Windows.

Crea una matriz de identificadores para los iconos extraídos de un archivo especificado.

Sintaxis

UINT PrivateExtractIconsA(
  [in]            LPCSTR szFileName,
  [in]            int    nIconIndex,
  [in]            int    cxIcon,
  [in]            int    cyIcon,
  [out, optional] HICON  *phicon,
  [out, optional] UINT   *piconid,
  [in]            UINT   nIcons,
  [in]            UINT   flags
);

Parámetros

[in] szFileName

Tipo: LPCTSTR

Ruta de acceso y nombre del archivo desde el que se van a extraer los iconos.

[in] nIconIndex

Tipo: int

Índice de base cero del primer icono que se va a extraer. Por ejemplo, si este valor es cero, la función extrae el primer icono del archivo especificado.

[in] cxIcon

Tipo: int

Se quería el tamaño del icono horizontal. Vea la sección Comentarios.

[in] cyIcon

Tipo: int

Se quería el tamaño del icono vertical. Vea la sección Comentarios.

[out, optional] phicon

Tipo: HICON*

Puntero a la matriz de identificadores de icono devuelta.

[out, optional] piconid

Tipo: UINT*

Puntero a un identificador de recursos devuelto para el icono que mejor se ajusta al dispositivo de visualización actual. El identificador devuelto se 0xFFFFFFFF si el identificador no está disponible para este formato. El identificador devuelto es 0 si el identificador no se puede obtener de otro modo.

[in] nIcons

Tipo: UINT

Número de iconos que se van a extraer del archivo. Este parámetro solo es válido al extraer de archivos .exe y .dll.

[in] flags

Tipo: UINT

Especifica marcas que controlan esta función. Estas marcas son las marcas LR_* usadas por la función LoadImage .

Valor devuelto

Tipo: UINT

Si el parámetro phicon es NULL y esta función se realiza correctamente, el valor devuelto es el número de iconos del archivo. Si se produce un error en la función, el valor devuelto es 0.

Si el parámetro phicon no es NULL y la función se realiza correctamente, el valor devuelto es el número de iconos extraídos. De lo contrario, el valor devuelto se 0xFFFFFFFF si no se encuentra el archivo.

Comentarios

Esta función extrae de archivos ejecutables (.exe), DLL (.dll), icono (.ico), cursor (.cur), cursor animado (.ani) y mapa de bits (.bmp). También se admiten extracciones de archivos ejecutables de Windows 3.x de 16 bits (.exe o .dll).

Los parámetros cxIcon y cyIcon especifican el tamaño de los iconos que se van a extraer. Se pueden extraer dos tamaños colocando el primer tamaño en la LOWORD del parámetro y el segundo tamaño en HIWORD. Por ejemplo, MAKELONG(24, 48) para los parámetros cxIcon y cyIcon extraerían iconos de tamaño 24 y 48.

Debe destruir todos los iconos extraídos por PrivateExtractIcons mediante una llamada a la función DestroyIcon .

Esta función no se incluyó en los encabezados y bibliotecas del SDK hasta Windows XP Service Pack 1 (SP1) y Windows Server 2003. Si no tiene un archivo de encabezado y una biblioteca de importación para esta función, puede llamar a la función mediante LoadLibrary y GetProcAddress.

Nota

El encabezado winuser.h define PrivateExtractIcons 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


Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winuser.h
Library	User32.lib
Archivo DLL	User32.dll
Conjunto de API	ext-ms-win-ntuser-misc-l1-5-1 (introducido en Windows 10, versión 10.0.14393)