Función SHDefExtractIconA (shlobj_core.h)

Artículo
11/20/2024

Proporciona un controlador predeterminado para extraer un icono de un archivo.

Sintaxis

SHSTDAPI SHDefExtractIconA(
  [in]            LPCSTR pszIconFile,
                  int    iIndex,
  [in]            UINT   uFlags,
  [out, optional] HICON  *phiconLarge,
  [out, optional] HICON  *phiconSmall,
                  UINT   nIconSize
);

Parámetros

[in] pszIconFile

Tipo: LPCTSTR de

Puntero a un búfer terminado en null que contiene la ruta de acceso y el nombre del archivo desde el que se extrae el icono.

iIndex

Tipo: int

Ubicación del icono dentro del archivo denominado en pszIconFile. Si se trata de un número positivo, hace referencia a la posición de base cero del icono en el archivo. Por ejemplo, 0 hace referencia al 1º icono del archivo de recursos y 2 hace referencia a la tercera. Si se trata de un número negativo, hace referencia al identificador de recurso del icono.

[in] uFlags

Tipo: UINT

Marca que controla la extracción de iconos.

GIL_SIMULATEDOC

Superpone el icono extraído en el icono de documento predeterminado para crear el icono final. Este icono se puede usar cuando no se puede encontrar o recuperar ningún icono más adecuado.

[out, optional] phiconLarge

Tipo: HICON*

Puntero a un HICON que, cuando esta función vuelve correctamente, recibe el identificador de la versión grande del icono especificado en la LOWORD de nIconSize. Este valor puede ser null.

[out, optional] phiconSmall

Tipo: HICON*

Puntero a un HICON que, cuando esta función vuelve correctamente, recibe el identificador de la versión pequeña del icono especificado en el HIWORD de nIconSize.

nIconSize

Tipo: UINT

Valor que contiene el tamaño de icono grande en su LOWORD y el tamaño de icono pequeño en su HIWORD. El tamaño se mide en píxeles. Pase 0 para especificar tamaños grandes y pequeños predeterminados.

Valor devuelto

Tipo: HRESULT

Esta función puede devolver uno de estos valores.

Código devuelto	Descripción
S_OK	Éxito.
S_FALSE	El icono solicitado no está presente.
E_FAIL	No se puede acceder al archivo o se accede a él a través de un vínculo lento.

Observaciones

Es responsabilidad del autor de la llamada liberar los recursos de icono creados a través de esta función cuando ya no son necesarios. Esto se puede hacer a través de la función de DestroyIcon.

Nota

El encabezado shlobj_core.h define SHDefExtractIcon 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 neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Conventions for Function Prototypes.

Requisitos

Requisito	Valor
cliente mínimo admitido	Windows XP [solo aplicaciones de escritorio]
servidor mínimo admitido	Windows Server 2003 [solo aplicaciones de escritorio]
de la plataforma de destino de	Windows
encabezado de	shlobj_core.h (incluya Shlobj.h, Shlobj_core.h)
biblioteca de	Shell32.lib
DLL de	Shell32.dll (versión 6.0 o posterior)
conjunto de API de	ext-ms-win-shell-shell32-l1-2-1 (introducido en Windows 10, versión 10.0.10240)

Compartir a través de