IShellIconOverlay::GetOverlayIndex-Methode (shlobj_core.h)

  • Artikel

Ruft den Überlagerungsindex in der Systembildliste ab.

Syntax

HRESULT GetOverlayIndex(
  [in]      PCUITEMID_CHILD pidl,
  [in, out] int             *pIndex
);

Parameter

[in] pidl

Typ: PCUITEMID_CHILD

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

[in, out] pIndex

Typ: int*

Zeiger auf einen Wert, der den Überlagerungsindex (einbasiert) in der Systembildliste angibt. Dieser Index entspricht dem iOverlay-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 keine Überlagerung vorhanden.
E_FAIL
 Die PIDL ist ungültig.
E_INVALIDARG
 Das Argument ist ungültig, z. B. wenn pIndexNULL ist.
E_PENDING
 Die aufrufende Anwendung hat OI_ASYNC übergeben, um anzugeben, dass die Berechnung des Überlagerungsindexes einige Zeit in Anspruch nimmt.

Hinweise

Rufen Sie SHGetIconOverlayIndex auf, um den Überlagerungsindex in der Systembildliste abzurufen.

Wenn Sie pIndex festlegen, um auf OI_ASYNC zu zeigen, wenn Sie diese Methode aufrufen, gibt der Shellsymbolüberlagerungshandler möglicherweise E_PENDING zurück, anstatt den Überlagerungsindex in pIndex zu speichern. Dieser Rückgabewert gibt an, dass das Berechnen der Überlagerung ein langsamer Vorgang ist und im Hintergrund behandelt werden sollte. Wenn eine IShellIconOverlay-Implementierung E_PENDING zurückgibt, wird sie in einem Hintergrundarbeitsthread ohne das flag OI_ASYNC aufgerufen. Wenn Sie beim Aufrufen von GetOverlayIndex nicht OI_ASYNC verwenden, muss der Überlagerungshandler den Überlagerungsindex berechnen und den Wert vor der Rückgabe in pIndex speichern.

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