IShellIconOverlayIdentifier::GetOverlayInfo-Methode (shobjidl_core.h)

Artikel
08/26/2023

Stellt die Position der Bitmap der Symbolüberlagerung bereit.

Syntax

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

Parameter

[out] pwszIconFile

Typ: PWSTR

Eine unicode-Zeichenfolge mit Null-Endung, die den vollqualifizierten Pfad der Datei enthält, die das Symbol enthält. Die Dateitypen .dll, .exe und ICO sind akzeptabel. Sie müssen das ISIOI_ICONFILE-Flag in pdwFlags festlegen, wenn Sie einen Dateinamen zurückgeben.

cchMax

Typ: int

Die Größe des pwszIconFile-Puffers in Unicode-Zeichen.

[out] pIndex

Typ: int*

Zeiger auf einen Indexwert, der zum Identifizieren des Symbols in einer Datei verwendet wird, die mehrere Symbole enthält. Sie müssen das ISIOI_ICONINDEX-Flag in pdwFlags festlegen, wenn Sie einen Index zurückgeben.

[out] pdwFlags

Typ: DWORD*

Zeiger auf eine Bitmap, die die von der -Methode zurückgegebenen Informationen angibt. Bei diesem Parameter kann es sich um einen oder beide der folgenden Werte handeln.

ISIOI_ICONFILE (0x00000001)

Der Pfad der Symboldatei wird über pwszIconFile zurückgegeben.

ISIOI_ICONINDEX (0x00000002)

PwszIconFile enthält mehrere Symbole. Der Index des Symbols wird über pIndex zurückgegeben.

Rückgabewert

Typ: HRESULT

Wenn diese Methode erfolgreich ist, wird S_OK zurückgegeben. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Diese Methode wird beim Start von der Shell aufgerufen, sodass die Symbolüberlagerung des Handlers der Systemimageliste hinzugefügt werden kann. Nach Abschluss der Initialisierung ruft die Shell GetOverlayInfo auf, wenn die Symbolüberlagerung des Handlers angezeigt werden muss.

Hinweis Nachdem das Image während der Initialisierung in die Systemimageliste geladen wurde, kann es nicht mehr geändert werden. Nach der Initialisierung werden der Dateiname und der Index nur zum Identifizieren der Symbolüberlagerung verwendet. Das System lädt keine neue Symbolüberlagerung. Wenn GetOverlayInfo aufgerufen wird, muss Ihr Handler denselben Dateinamen und Index zurückgeben, die beim ersten Aufruf der Funktion angegeben wurden.

Anforderungen


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	shobjidl_core.h (shlobj.h einschließen)
DLL	Shell32.dll (Version 5.0 oder höher)

Share via