Fonction ExtractIconA (shellapi.h)

  • Article

Obtient un handle vers une icône à partir du fichier exécutable, dll ou fichier d’icône spécifié.

Pour récupérer un tableau de handles dans des icônes grandes ou petites, utilisez la fonction ExtractIconEx .

Syntaxe

HICON ExtractIconA(
  [in] HINSTANCE hInst,
  [in] LPCSTR    pszExeFileName,
       UINT      nIconIndex
);

Paramètres

[in] hInst

Type : HINSTANCE

Gérez vers le instance de l’application qui appelle la fonction.

[in] pszExeFileName

Type : LPCTSTR

Pointeur vers une chaîne terminée par null qui spécifie le nom d’un fichier exécutable, d’une DLL ou d’un fichier d’icône.

nIconIndex

Type : UINT

Spécifie l’index de base zéro de l’icône à récupérer. Par exemple, si cette valeur est 0, la fonction retourne un handle à la première icône dans le fichier spécifié.

Si cette valeur est -1, la fonction retourne le nombre total d’icônes dans le fichier spécifié. Si le fichier est un fichier exécutable ou une DLL, la valeur renvoyée est le nombre de ressources RT_GROUP_ICON. Si le fichier est un . Fichier ICO, la valeur de retour est 1.

Si cette valeur est un nombre négatif non égal à –1, la fonction retourne un handle à l’icône dans le fichier spécifié dont l’identificateur de ressource est égal à la valeur absolue de nIconIndex. Par exemple, vous devez utiliser –3 pour extraire l’icône dont l’identificateur de ressource est 3. Pour extraire l’icône dont l’identificateur de ressource est 1, utilisez la fonction ExtractIconEx .

Valeur retournée

Type : HICON

La valeur de retour est un handle d’une icône. Si le fichier spécifié n’était pas un fichier exécutable, une DLL ou un fichier d’icônes, le retour est 1. Si aucune icône n’a été trouvée dans le fichier, la valeur de retour est NULL.

Remarques

Quand elle n’est plus nécessaire, vous devez détruire le handle d’icône retourné par ExtractIcon en appelant la fonction DestroyIcon .

Notes

L’en-tête shellapi.h définit ExtractIcon comme un 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.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge Windows 2000 Server [applications de bureau uniquement]
Plateforme cible Windows
En-tête shellapi.h
DLL Shell32.dll
Ensemble d’API ext-ms-win-shell-shell32-l1-2-1 (introduit dans Windows 10, version 10.0.10240)

Voir aussi

ExtractAssociatedIcon

ExtractAssociatedIconEx

ExtractIconEx