Fonction SHDefExtractIconW (shlobj_core.h)

Article
03/02/2024

Fournit un gestionnaire par défaut pour extraire une icône d’un fichier.

Syntaxe

SHSTDAPI SHDefExtractIconW(
  [in]            LPCWSTR pszIconFile,
                  int     iIndex,
  [in]            UINT    uFlags,
  [out, optional] HICON   *phiconLarge,
  [out, optional] HICON   *phiconSmall,
                  UINT    nIconSize
);

Paramètres

[in] pszIconFile

Type : LPCTSTR

Pointeur vers une mémoire tampon terminée par un caractère Null qui contient le chemin et le nom du fichier à partir duquel l’icône est extraite.

iIndex

Type : int

Emplacement de l’icône dans le fichier nommé dans pszIconFile. S’il s’agit d’un nombre positif, il fait référence à la position de base zéro de l’icône dans le fichier. Pour instance, 0 fait référence à la 1ère icône dans le fichier de ressources et 2 fait référence à la 3e. S’il s’agit d’un nombre négatif, il fait référence à l’ID de ressource de l’icône.

[in] uFlags

Type : UINT

Indicateur qui contrôle l’extraction de l’icône.

GIL_SIMULATEDOC

Superpose l’icône extraite sur l’icône de document par défaut pour créer l’icône finale. Cette icône peut être utilisée lorsqu’aucune icône plus appropriée ne peut être trouvée ou récupérée.

[out, optional] phiconLarge

Type : HICON*

Pointeur vers un HICON qui, lorsque cette fonction retourne correctement, reçoit le handle de la version volumineuse de l’icône spécifiée dans le LOWORD de nIconSize. Cette valeur peut être NULL.

[out, optional] phiconSmall

Type : HICON*

Pointeur vers un HICON qui, lorsque cette fonction retourne correctement, reçoit le handle de la petite version de l’icône spécifiée dans hiword de nIconSize.

nIconSize

Type : UINT

Valeur qui contient la grande taille d’icône dans son LOWORD et la petite taille d’icône dans son HIWORD. La taille est mesurée en pixels. Passez 0 pour spécifier les tailles par défaut, grandes et petites.

Valeur retournée

Type : HRESULT

Cette fonction peut retourner l’une de ces valeurs.

Code de retour	Description
S_OK	Opération réussie.
S_FALSE	L’icône demandée n’est pas présente.
E_FAIL	Le fichier est inaccessible ou est accessible via un lien lent.

Remarques

Il incombe à l’appelant de libérer les ressources d’icône créées par le biais de cette fonction quand elles ne sont plus nécessaires. Cela peut être effectué par le biais de la fonction DestroyIcon .

Notes

L’en-tête shlobj_core.h définit SHDefExtractIcon 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 Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	shlobj_core.h (inclure Shlobj.h, Shlobj_core.h)
Bibliothèque	Shell32.lib
DLL	Shell32.dll (version 6.0 ou ultérieure)
Ensemble d’API	ext-ms-win-shell-shell32-l1-2-1 (introduit dans Windows 10, version 10.0.10240)

Partager via