Méthode IShellIconOverlay ::GetOverlayIconIndex (shlobj_core.h)

Article
03/02/2024

Obtient l’index de la superposition d’icônes dans la liste d’images système.

Syntaxe

HRESULT GetOverlayIconIndex(
  [in]      PCUITEMID_CHILD pidl,
  [in, out] int             *pIconIndex
);

Paramètres

[in] pidl

Type : PCUITEMID_CHILD

Pointeur vers une structure ITEMIDLIST qui identifie l’objet dont l’icône est affichée.

[in, out] pIconIndex

Type : int*

Pointeur vers l’index de l’image de superposition d’icône dans la liste d’images système. Cet index équivaut à la valeur iImage spécifiée lorsque vous ajoutez une image superposée à une liste d’images privées avec la fonction ImageList ::SetOverlayImage .

Valeur retournée

Type : HRESULT

Cette méthode peut retourner l’une de ces valeurs.

Code de retour	Description
S_OK	L’index d’une superposition a été trouvé.
S_FALSE	Il n’existe aucune superposition pour ce fichier.
E_FAIL	Le PIDL n’est pas valide.

Remarques

Pour récupérer l’index d’image de la superposition dans la liste d’images système, vous devez d’abord appeler SHGetIconOverlayIndex pour récupérer l’index de superposition. Utilisez ensuite la macro INDEXTOOVERLAYMASK pour convertir l’index de superposition en index d’image équivalent.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 2000 Professionnel, 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
DLL	Shell32.dll (version 5.0 ou ultérieure)

Voir aussi

IShellIconOverlay

Partager via