SHDefExtractIconA-Funktion (shlobj_core.h)

Artikel
08/26/2023

Stellt einen Standardhandler zum Extrahieren eines Symbols aus einer Datei bereit.

Syntax

SHSTDAPI SHDefExtractIconA(
  [in]            LPCSTR pszIconFile,
                  int    iIndex,
  [in]            UINT   uFlags,
  [out, optional] HICON  *phiconLarge,
  [out, optional] HICON  *phiconSmall,
                  UINT   nIconSize
);

Parameter

[in] pszIconFile

Typ: LPCTSTR

Ein Zeiger auf einen Puffer mit NULL-Beendigung, der den Pfad und Namen der Datei enthält, aus der das Symbol extrahiert wird.

iIndex

Typ: int

Der Speicherort des Symbols in der Datei mit dem Namen in pszIconFile. Wenn es sich um eine positive Zahl handelt, bezieht sie sich auf die nullbasierte Position des Symbols in der Datei. Für instance bezieht sich 0 auf das 1. Symbol in der Ressourcendatei und 2 auf das dritte Symbol. Wenn es sich um eine negative Zahl handelt, bezieht sie sich auf die Ressourcen-ID des Symbols.

[in] uFlags

Typ: UINT

Ein Flag, das die Symbolextraktion steuert.

GIL_SIMULATEDOC

Überlagert das extrahierte Symbol auf dem Standarddokumentsymbol, um das endgültige Symbol zu erstellen. Dieses Symbol kann verwendet werden, wenn kein passendes Symbol gefunden oder abgerufen werden kann.

[out, optional] phiconLarge

Typ: HICON*

Ein Zeiger auf einen HICON, der nach erfolgreicher Rückgabe dieser Funktion das Handle der großen Version des Symbols empfängt, das in LOWORD von nIconSize angegeben ist. Dieser Wert kann NULL sein.

[out, optional] phiconSmall

Typ: HICON*

Ein Zeiger auf einen HICON, der, wenn diese Funktion erfolgreich zurückgibt, das Handle der kleinen Version des Symbols empfängt, das im HIWORD von nIconSize angegeben ist.

nIconSize

Typ: UINT

Ein -Wert, der die große Symbolgröße in loword und die kleine Symbolgröße in hiword enthält. Die Größe wird in Pixeln gemessen. Übergeben Sie 0, um die Standardgrößen "Groß" und "Klein" anzugeben.

Rückgabewert

Typ: HRESULT

Diese Funktion kann einen dieser Werte zurückgeben.

Rückgabecode	BESCHREIBUNG
S_OK	Erfolg.
S_FALSE	Das angeforderte Symbol ist nicht vorhanden.
E_FAIL	Auf die Datei kann nicht zugegriffen werden, oder der Zugriff erfolgt über einen langsamen Link.

Hinweise

Es liegt in der Verantwortung des Aufrufers, die über diese Funktion erstellten Symbolressourcen freizugeben, wenn sie nicht mehr benötigt werden. Dies kann über die DestroyIcon-Funktion erfolgen.

Hinweis

Der shlobj_core.h-Header definiert SHDefExtractIcon 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


Unterstützte Mindestversion (Client)	Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	shlobj_core.h (einschließlich Shlobj.h, Shlobj_core.h)
Bibliothek	Shell32.lib
DLL	Shell32.dll (Version 6.0 oder höher)
APIs	ext-ms-win-shell-shell32-l1-2-1 (eingeführt in Windows 10, Version 10.0.10240)