SHDefExtractIconA, fonction (shlobj_core.h)

Article
11/20/2024

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

Syntaxe

SHSTDAPI SHDefExtractIconA(
  [in]            LPCSTR 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 null qui contient le chemin d’accès 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. Par exemple, 0 fait référence à l’icône 1ère dans le fichier de ressources et 2 fait référence au 3ème. 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 d’icônes.

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 n’est trouvée ou récupérée.

[out, optional] phiconLarge

Type : HICON*

Pointeur vers un HICON qui, lorsque cette fonction est retournée avec succès, reçoit le handle de la grande version de l’icône spécifiée dans la 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 la HIWORD de nIconSize.

nIconSize

Type : uiNT

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

Valeur de retour

Type : HRESULT

Cette fonction peut retourner l’une de ces valeurs.

Retourner le code	Description
S_OK	Succès.
S_FALSE	L’icône demandée n’est pas présente.
E_FAIL	Le fichier n’est pas accessible ou est accessible via un lien lent.

Remarques

Il incombe à l’appelant de libérer les ressources d’icône créées via cette fonction lorsqu’elles ne sont plus nécessaires. Cette opération peut être effectuée via la fonction DestroyIcon.

Note

L’en-tête shlobj_core.h définit SHDefExtractIcon 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 XP [applications de bureau uniquement]
serveur minimum pris en charge	Windows Server 2003 [applications de bureau uniquement]
plateforme cible	Windows
d’en-tête	shlobj_core.h (include 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