Función LoadIconA (winuser.h)

Artículo
11/20/2024

Carga el recurso de icono especificado desde el archivo ejecutable (.exe) asociado a una instancia de aplicación.

Nota

Esta función se ha reemplazado por la función LoadImage (con marcas LR_DEFAULTSIZE y LR_SHARED establecidas).

Sintaxis

HICON LoadIconA(
  [in, optional] HINSTANCE hInstance,
  [in]           LPCSTR    lpIconName
);

Parámetros

[in, optional] hInstance

Tipo: HINSTANCE

Identificador del módulo de un archivo DLL o ejecutable (.exe) que contiene el icono que se va a cargar. Para obtener más información, vea getModuleHandle.

Para cargar un icono de sistema predefinido, establezca este parámetro en NULL.

[in] lpIconName

Tipo: LPCTSTR de

Si hInstance no esNULL, lpIconName especifica el recurso de icono por nombre o ordinal. Este ordinal se debe empaquetar mediante la macro MAKEINTRESOURCE .

Si hInstance es null, lpIconName especifica el identificador de (empezando por el prefijo IDI_) de un icono de sistema predefinido que se va a cargar.

Valor devuelto

Tipo: HICON

Si la función se ejecuta correctamente, el valor devuelto es un identificador del icono recién cargado.

Si se produce un error en la función, el valor devuelto es NULL. Para obtener información de error extendida, llame a GetLastError.

Observaciones

LoadIcon carga el recurso de icono solo si no se ha cargado; de lo contrario, recupera un identificador para el recurso existente. La función busca en el recurso de icono el icono más adecuado para la pantalla actual. El recurso de icono puede ser un mapa de bits de color o monocromo.

LoadIcon solo puede cargar un icono cuyo tamaño se ajusta a los valores de métrica del sistema de SM_CXICON y SM_CYICON. Use la función LoadImage para cargar iconos de otros tamaños.

Nota

El encabezado winuser.h define LoadIcon 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 2000 Professional [solo aplicaciones de escritorio]
servidor mínimo admitido	Windows 2000 Server [solo aplicaciones de escritorio]
de la plataforma de destino de	Windows
encabezado de	winuser.h (incluya Windows.h)
biblioteca de	User32.lib
DLL de	User32.dll
conjunto de API de	ext-ms-win-ntuser-gui-l1-1-0 (introducido en Windows 8)