SHDefExtractIconA-Funktion (shlobj_core.h)

Artikel
11/20/2024

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 mit Null beendeten Puffer, der den Pfad und den Namen der Datei enthält, aus der das Symbol extrahiert wird.

iIndex

Typ: int

Der Speicherort des Symbols in der Datei, die in pszIconFilebenannt ist. Wenn dies eine positive Zahl ist, bezieht sie sich auf die nullbasierte Position des Symbols in der Datei. Beispielsweise bezieht sich 0 auf das 1. Symbol in der Ressourcendatei und 2 bezieht sich auf den 3. Wenn dies eine negative Zahl ist, bezieht sie sich auf die Ressourcen-ID des Symbols.

[in] uFlags

Typ: UINT-

Ein Kennzeichen, 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 ein HICON, der, wenn diese Funktion erfolgreich zurückgegeben wird, das Handle der großen Version des Symbols empfängt, das in der LOWORD- von nIconSizeangegeben ist. Dieser Wert kann NULL-sein.

[out, optional] phiconSmall

Typ: HICON*

Ein Zeiger auf ein HICON, der, wenn diese Funktion erfolgreich zurückgegeben wird, das Handle der kleinen Version des Symbols empfängt, das in der HIWORD- von nIconSizeangegeben ist.

nIconSize

Typ: UINT-

Ein Wert, der die große Symbolgröße in der LOWORD- und die kleine Symbolgröße in der HIWORD-enthält. Die Größe wird in Pixel gemessen. Übergeben Sie 0, um die Standardgröße für große und kleine Größen 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 über einen langsamen Link aufgerufen werden.

Bemerkungen

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

Anmerkung

Der header shlobj_core.h 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

Anforderung	Wert
mindestens unterstützte Client-	Windows XP [nur Desktop-Apps]
mindestens unterstützte Server-	Windows Server 2003 [Nur Desktop-Apps]
Zielplattform-	Fenster
Header-	shlobj_core.h (einschließlich Shlobj.h, Shlobj_core.h)
Library	Shell32.lib
DLL-	Shell32.dll (Version 6.0 oder höher)
API-Satz	ext-ms-win-shell-shell32-l1-2-1 (eingeführt in Windows 10, Version 10.0.10240)

Freigeben über