ExtractIconA-Funktion (shellapi.h)
Ruft ein Handle zu einem Symbol aus der angegebenen ausführbaren Datei, DLL oder Symboldatei ab.
Verwenden Sie die ExtractIconEx--Funktion, um ein Array von Ziehpunkten für große oder kleine Symbole abzurufen.
Syntax
HICON ExtractIconA(
[in] HINSTANCE hInst,
[in] LPCSTR pszExeFileName,
UINT nIconIndex
);
Parameter
[in] hInst
Typ: HINSTANCE-
Behandeln Sie die Instanz der Anwendung, die die Funktion aufruft.
[in] pszExeFileName
Typ: LPCTSTR-
Zeigen Sie auf eine mit Null beendete Zeichenfolge, die den Namen einer ausführbaren Datei, DLL oder Symboldatei angibt.
nIconIndex
Typ: UINT-
Gibt den nullbasierten Index des abzurufenden Symbols an. Wenn dieser Wert beispielsweise 0 ist, gibt die Funktion ein Handle an das erste Symbol in der angegebenen Datei zurück.
Wenn dieser Wert -1 ist, gibt die Funktion die Gesamtzahl der Symbole in der angegebenen Datei zurück. Wenn es sich bei der Datei um eine ausführbare Datei oder DLL handelt, ist der Rückgabewert die Anzahl der RT_GROUP_ICON Ressourcen. Wenn es sich bei der Datei um eine . ICO-Datei, der Rückgabewert ist 1.
Wenn dieser Wert eine negative Zahl ungleich -1 ist, gibt die Funktion ein Handle an das Symbol in der angegebenen Datei zurück, dessen Ressourcenbezeichner dem absoluten Wert von nIconIndexentspricht. Sie sollten z. B. "-3" verwenden, um das Symbol zu extrahieren, dessen Ressourcenbezeichner 3 ist. Um das Symbol zu extrahieren, dessen Ressourcenbezeichner 1 ist, verwenden Sie die ExtractIconEx--Funktion.
Rückgabewert
Typ: HICON-
Der Rückgabewert ist ein Handle für ein Symbol. Wenn die angegebene Datei keine ausführbare Datei, DLL oder Symboldatei war, lautet die Rückgabe 1. Wenn in der Datei keine Symbole gefunden wurden, ist der Rückgabewert NULL-.
Bemerkungen
Wenn sie nicht mehr benötigt wird, müssen Sie den von ExtractIcon zurückgegebenen Symbolpunkt zerstören, indem Sie die funktion DestroyIcon aufrufen.
Anmerkung
Der shellapi.h-Header definiert ExtractIcon 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 2000 Server [nur Desktop-Apps] |
| Zielplattform- | Fenster |
| Header- | shellapi.h |
| DLL- | Shell32.dll |
| API-Satz | ext-ms-win-shell-shell32-l1-2-1 (eingeführt in Windows 10, Version 10.0.10240) |