Función LoadIconA (winuser.h)

Artículo
03/04/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 LR_DEFAULTSIZE y marcas de 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

Si hInstance no es NULL, lpIconName especifica el recurso de icono por nombre o ordinal. Este ordinal debe empaquetarse mediante la macro MAKEINTRESOURCE .

Si hInstance es NULL, lpIconName especifica el identificador (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 para el icono recién cargado.

Si la función no se realiza correctamente, el valor devuelto es NULL. Para obtener información de error extendida, llame a GetLastError.

Comentarios

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 al SM_CXICON y SM_CYICON valores de métrica del sistema. 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 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 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	winuser.h (incluya Windows.h)
Library	User32.lib
Archivo DLL	User32.dll
Conjunto de API	ext-ms-win-ntuser-gui-l1-1-0 (introducido en Windows 8)