IShellIconOverlay::GetOverlayIconIndex-Methode (shlobj_core.h)

  • Artikel

Ruft den Index der Symbolüberlagerung in der Systembildliste ab.

Syntax

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

Parameter

[in] pidl

Typ: PCUITEMID_CHILD

Zeiger auf eine ITEMIDLIST-Struktur , die das Objekt identifiziert, dessen Symbol angezeigt wird.

[in, out] pIconIndex

Typ: int*

Zeiger auf den Index des Bilds des Symbolüberlagerungs in der Systembildliste. Dieser Index entspricht dem iImage-Wert , der angegeben wird, wenn Sie einer privaten Bildliste mit der ImageList::SetOverlayImage-Funktion ein Überlagerungsbild hinzufügen.

Rückgabewert

Typ: HRESULT

Diese Methode kann einen dieser Werte zurückgeben.

Rückgabecode BESCHREIBUNG
S_OK
 Der Index einer Überlagerung wurde gefunden.
S_FALSE
 Für diese Datei ist kein Overlay vorhanden.
E_FAIL
 Die PIDL ist ungültig.

Hinweise

Um den Bildindex des Overlays in der Systembildliste abzurufen, müssen Sie zuerst SHGetIconOverlayIndex aufrufen, um den Überlagerungsindex abzurufen. Verwenden Sie dann das Makro INDEXTOOVERLAYMASK , um den Überlagerungsindex in den entsprechenden Bildindex zu konvertieren.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows 2000 Professional, Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2003 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile shlobj_core.h
DLL Shell32.dll (Version 5.0 oder höher)

Weitere Informationen

IShellIconOverlay