SHGetIconOverlayIndexA-Funktion (shlobj_core.h)

Artikel
11/20/2024

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 mit Null beendete 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 pszIconPathverweist. Um ein Standardüberlagerungssymbol anzufordern, legen Sie pszIconPath- auf NULL-fest, und iIconIndex- auf eine der folgenden Optionen:

IDO_SHGIOI_SHARE (0x0FFFFFFF)

Das Überlagerungssymbol, das einen freigegebenen Ordner angibt.

IDO_SHGIOI_LINK (0x0FFFFFFE)

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

IDO_SHGIOI_SLOWFILE (0x0FFFFFFD)

Das Überlagerungssymbol, das eine langsame Datei angibt.

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 den Index des Überlagerungssymbols in der Systembildliste zurück, falls erfolgreich, oder -1 andernfalls.

Bemerkungen

Symbolüberlagerungen sind Teil der Systembildliste. Sie haben zwei Bezeichner. Der erste ist ein 1-basierter Ü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 dem iOverlay- und iImage- Parametern zuweisen, bzw. , wenn Sie einer privaten Bildliste mit ImageList_SetOverlayImageeine Symbolüberlagerung hinzufügen. SHGetIconOverlayIndex den Überlagerungsindex zurück. Um einen Überlagerungsindex in den entsprechenden Bildindex zu konvertieren, rufen Sie INDEXTOOVERLAYMASKauf.

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

Anmerkung

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

Anforderungen

Anforderung	Wert
mindestens unterstützte Client-	Windows 2000 Professional [nur Desktop-Apps]
mindestens unterstützte Server-	Windows 2000 Server [nur Desktop-Apps]
Zielplattform-	Fenster
Header-	shlobj_core.h (einschließlich Shlobj.h, Shlobj_core.h)
Library	Shell32.lib
DLL-	Shell32.dll (Version 5.0 oder höher)

Siehe auch

IShellIconOverlay-

IShellIconOverlayIdentifier-

Freigeben über