Méthode IShellIconOverlayIdentifier::GetOverlayInfo (shobjidl_core.h)

Article
08/26/2023

Fournit l’emplacement de la bitmap de superposition de l’icône.

Syntaxe

HRESULT GetOverlayInfo(
  [out] LPWSTR pwszIconFile,
        int    cchMax,
  [out] int    *pIndex,
  [out] DWORD  *pdwFlags
);

Paramètres

[out] pwszIconFile

Type : PWSTR

Chaîne Unicode terminée par un caractère Null qui contient le chemin complet du fichier contenant l’icône. Les types de fichiers .dll, .exe et .ico sont tous acceptables. Vous devez définir l’indicateur ISIOI_ICONFILE dans pdwFlags si vous retournez un nom de fichier.

cchMax

Type : int

Taille de la mémoire tampon pwszIconFile , en caractères Unicode.

[out] pIndex

Type : int*

Pointeur vers une valeur d’index utilisée pour identifier l’icône dans un fichier contenant plusieurs icônes. Vous devez définir l’indicateur ISIOI_ICONINDEX dans pdwFlags si vous retournez un index.

[out] pdwFlags

Type : DWORD*

Pointeur vers une bitmap qui spécifie les informations retournées par la méthode . Ce paramètre peut être l’une des valeurs suivantes, ou les deux.

ISIOI_ICONFILE (0x00000001)

Le chemin du fichier d’icône est retourné via pwszIconFile.

ISIOI_ICONINDEX (0x00000002)

PwszIconFile comporte plusieurs icônes. L’index de l’icône est retourné via pIndex.

Valeur retournée

Type : HRESULT

Si cette méthode réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Remarques

Cette méthode est appelée par l’interpréteur de commandes au démarrage afin que la superposition d’icônes du gestionnaire puisse être ajoutée à la liste des images système. Une fois l’initialisation terminée, l’interpréteur de commandes appelle GetOverlayInfo lorsqu’il doit afficher la superposition d’icônes du gestionnaire.

Note Une fois l’image chargée dans la liste d’images système pendant l’initialisation, elle ne peut pas être modifiée. Après l’initialisation, le nom de fichier et l’index sont utilisés uniquement pour identifier la superposition d’icônes. Le système ne charge pas de nouvelle superposition d’icônes. Lorsque GetOverlayInfo est appelé, votre gestionnaire doit retourner le nom de fichier et l’index spécifiés lors de l’appel de la fonction pour la première fois.

Configuration requise


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	shobjidl_core.h (inclure Shlobj.h)
DLL	Shell32.dll (version 5.0 ou ultérieure)

Partager via