Fonction ExtractAssociatedIconA (shellapi.h)

  • Article

Obtient un handle pour une icône stockée en tant que ressource dans un fichier ou une icône stockée dans le fichier exécutable associé à un fichier.

Syntaxe

HICON ExtractAssociatedIconA(
  [in]      HINSTANCE hInst,
  [in, out] LPSTR     pszIconPath,
  [in, out] WORD      *piIcon
);

Paramètres

[in] hInst

Type : HINSTANCE

Handle pour le instance de l’application appelante.

[in, out] pszIconPath

Type : LPTSTR

Pointeur vers une chaîne qui, lors de l’entrée, spécifie le chemin d’accès complet et le nom de fichier du fichier qui contient l’icône. La fonction extrait le handle d’icône de ce fichier ou d’un fichier exécutable associé à ce fichier.

Lorsque cette fonction retourne, si le handle d’icône a été obtenu à partir d’un fichier exécutable (soit un fichier exécutable pointé par lpIconPath , soit un fichier exécutable associé), la fonction stocke le chemin d’accès complet et le nom de fichier de ce fichier exécutable dans la mémoire tampon pointée par ce paramètre.

[in, out] piIcon

Type : LPWORD

Pointeur vers une valeur WORD qui, lors de l’entrée, spécifie l’index de l’icône dont le handle doit être obtenu.

Lorsque la fonction retourne, si le handle d’icône a été obtenu à partir d’un fichier exécutable (un fichier exécutable pointé par lpIconPath ou un fichier exécutable associé), cette valeur pointe vers l’index de l’icône dans ce fichier.

Valeur retournée

Type : HICON

Si la fonction réussit, la valeur de retour est un handle d’icône. Si l’icône est extraite d’un fichier exécutable associé, la fonction stocke le chemin d’accès complet et le nom de fichier du fichier exécutable dans la chaîne pointée par lpIconPath, et stocke l’identificateur de l’icône dans le WORD pointé par lpiIcon.

Si la fonction échoue, la valeur de retour est NULL.

Remarques

Lorsqu’il n’est plus nécessaire, l’appelant est chargé de libérer le handle d’icône retourné par ExtractAssociatedIcon en appelant la fonction DestroyIcon .

La fonction ExtractAssociatedIcon recherche d’abord l’icône indexée dans le fichier spécifié par lpIconPath. Si la fonction ne peut pas obtenir le handle d’icône à partir de ce fichier et que le fichier a un fichier exécutable associé, elle recherche une icône dans ce fichier exécutable. Les associations avec des fichiers exécutables sont basées sur des extensions de nom de fichier et sont stockées dans la partie par utilisateur du Registre.

Notes

L’en-tête shellapi.h définit ExtractAssociatedIcon en tant qu’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. La combinaison 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

ExtractAssociatedIconEx

ExtractIcon

ExtractIconEx