SHGetIconOverlayIndexA-Funktion (shlobj_core.h)

  • Artikel

Gibt den Index des Überlagerungssymbols in der Systembildliste zurück.

Syntax

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

Parameter

[in, optional] pszIconPath

Typ: LPCTSTR

Ein Zeiger auf eine NULL-Zeichenfolge mit maximaler Länge MAX_PATH , die den vollqualifizierten Pfad der Datei enthält, die das Symbol enthält.

iIconIndex

Typ: int

Der Index des Symbols in der Datei, auf die von pszIconPath verwiesen wird. Um ein Standard-Overlaysymbol anzufordern, legen Sie pszIconPath auf NULL und iIconIndex auf eine der folgenden Werte fest:

IDO_SHGIOI_SHARE (0x0FFFFFFF)

Das Überlagerungssymbol, das einen freigegebenen Ordner angibt.

Das Überlagerungssymbol, das einen verknüpften Ordner oder eine verknüpfte Datei angibt.

IDO_SHGIOI_SLOWFILE (0x0FFFFFFD)

Das Überlagerungssymbol, das auf eine langsame Datei hinweist.

IDO_SHGIOI_DEFAULT (0x0FFFFFFC)

Windows 7 und höher. Das Überlagerungssymbol, das angibt, dass das Element der Standard in einem Satz ist. Ein Beispiel ist der Standarddrucker.

Rückgabewert

Typ: int

Gibt bei erfolgreicher Ausführung den Index des Überlagerungssymbols in der Systembildliste zurück, andernfalls -1.

Hinweise

Symbolüberlagerungen sind Teil der Systembildliste. Sie verfügen über zwei Bezeichner. Der erste ist ein einbasierter Überlagerungsindex, der die Überlagerung relativ zu anderen Überlagerungen in der Bildliste identifiziert. Die andere ist ein Bildindex, der das tatsächliche Bild identifiziert. Diese beiden Indizes entsprechen den Werten, die Sie den Parametern iOverlay bzw. iImage zuweisen, wenn Sie einer privaten Bildliste mit ImageList_SetOverlayImage eine Symbolüberlagerung hinzufügen. SHGetIconOverlayIndex gibt den Überlagerungsindex zurück. Um einen Überlagerungsindex in den entsprechenden Bildindex zu konvertieren, rufen Sie INDEXTOOVERLAYMASK auf.

Hinweis Nachdem das Image während der Initialisierung in die Systemimageliste geladen wurde, kann es nicht mehr geändert werden. Der von pszIconPath und iIconIndex angegebene Dateiname und Index werden nur verwendet, um die Symbolüberlagerung zu identifizieren. SHGetIconOverlayIndex kann nicht zum Ändern der Systemimageliste verwendet werden.
 

Hinweis

Der shlobj_core.h-Header definiert SHGetIconOverlayIndex als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit nicht codierungsneutralem Code kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

   
Unterstützte Mindestversion (Client) Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows 2000 Server [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile shlobj_core.h (einschließlich Shlobj.h, Shlobj_core.h)
Bibliothek Shell32.lib
DLL Shell32.dll (Version 5.0 oder höher)

Weitere Informationen

IShellIconOverlay

IShellIconOverlayIdentifier