LoadIconA, fonction (winuser.h)

Article
11/20/2024

Charge la ressource d’icône spécifiée à partir du fichier exécutable (.exe) associé à une instance d’application.

Note

Cette fonction a été remplacée par la fonction LoadImage (avec LR_DEFAULTSIZE et LR_SHARED indicateurs définis).

Syntaxe

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

Paramètres

[in, optional] hInstance

Type : HINSTANCE

Handle du module d’un fichier DLL ou exécutable (.exe) qui contient l’icône à charger. Pour plus d’informations, consultez GetModuleHandle.

Pour charger une icône système prédéfinie, définissez ce paramètre sur NULL .

[in] lpIconName

Type : LPCTSTR

Si hInstance n’est pasNULL, lpIconName spécifie la ressource d’icône par nom ou ordinal. Cet ordinal doit être empaqueté à l’aide de la macro MAKEINTRESOURCE.

Si hInstance est NULL, lpIconName spécifie l’identificateur (commençant par le préfixe IDI_) d’une icône système prédéfinie à charger.

Valeur de retour

Type : HICON

Si la fonction réussit, la valeur de retour est un handle vers l’icône nouvellement chargée.

Si la fonction échoue, la valeur de retour est NULL . Pour obtenir des informations d’erreur étendues, appelez GetLastError.

Remarques

LoadIcon charge la ressource d’icône uniquement si elle n’a pas été chargée ; sinon, il récupère un handle dans la ressource existante. La fonction recherche la ressource d’icône pour l’icône la plus appropriée pour l’affichage actuel. La ressource d’icône peut être une couleur ou une bitmap monochrome.

LoadIcon ne peut charger qu’une icône dont la taille est conforme aux valeurs de métriques système SM_CXICON et SM_CYICON. Utilisez la fonction LoadImage pour charger des icônes d’autres tailles.

Note

L’en-tête winuser.h définit LoadIcon comme alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
serveur minimum pris en charge	Windows 2000 Server [applications de bureau uniquement]
plateforme cible	Windows
d’en-tête	winuser.h (include Windows.h)
bibliothèque	User32.lib
DLL	User32.dll
ensemble d’API	ext-ms-win-ntuser-gui-l1-1-0 (introduit dans Windows 8)