SHGetIconOverlayIndexA, fonction (shlobj_core.h)

Article
11/20/2024

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

Syntaxe

int SHGetIconOverlayIndexA(
  [in, optional] LPCSTR pszIconPath,
                 int    iIconIndex
);

Paramètres

[in, optional] pszIconPath

Type : LPCTSTR

Pointeur vers une chaîne terminée par null de longueur maximale MAX_PATH qui contient le chemin complet du fichier qui contient l’icône.

iIconIndex

Type : int

Index de l’icône dans le fichier pointé par pszIconPath. Pour demander une icône de superposition standard, définissez pszIconPath sur NULL et iIconIndex sur l’une des options suivantes :

IDO_SHGIOI_SHARE (0x0FFFFFFF)

Icône de superposition qui indique un dossier partagé.

IDO_SHGIOI_LINK (0x0FFFFFFE)

Icône de superposition qui indique un dossier ou un fichier lié.

IDO_SHGIOI_SLOWFILE (0x0FFFFFFD)

Icône de superposition qui indique un fichier lent.

IDO_SHGIOI_DEFAULT (0x0FFFFFFC)

Windows 7 et versions ultérieures. Icône de superposition qui indique que l’élément est la valeur par défaut dans un ensemble. Par exemple, l’imprimante par défaut.

Valeur de retour

Type : int

Retourne l’index de l’icône de superposition dans la liste d’images système si elle réussit ou -1 sinon.

Remarques

Les superpositions d’icônes font partie de la liste d’images système. Ils ont deux identificateurs. Le premier est un index de superposition unique qui identifie la superposition par rapport à d’autres superpositions dans la liste d’images. L’autre est un index d’image qui identifie l’image réelle. Ces deux index sont équivalents aux valeurs que vous affectez au iOverlay et paramètres de iImage, respectivement, lorsque vous ajoutez une superposition d’icônes à une liste d’images privées avec ImageList_SetOverlayImage. SHGetIconOverlayIndex retourne l’index de superposition. Pour convertir un index de superposition en son index d’image équivalent, appelez INDEXTOOVERLAYMASK.

Remarque Une fois l’image chargée dans la liste d’images système lors de l’initialisation, elle ne peut pas être modifiée. Le nom de fichier et l’index spécifiés par pszIconPath et iIconIndex sont utilisés uniquement pour identifier la superposition d’icônes. SHGetIconOverlayIndex ne peut pas être utilisé pour modifier la liste d’images système.

Note

L’en-tête shlobj_core.h définit SHGetIconOverlayIndex 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 2000 Professionnel [applications de bureau uniquement]
serveur minimum pris en charge	Windows 2000 Server [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 5.0 ou ultérieure)

Voir aussi

IShellIconOverlay

IShellIconOverlayIdentifier

Partager via