ExtractIconExA-Funktion (shellapi.h)
Die ExtractIconEx--Funktion erstellt ein Array von Handles zu großen oder kleinen Symbolen, die aus der angegebenen ausführbaren Datei, DLL oder Symboldatei extrahiert wurden.
Syntax
UINT ExtractIconExA(
[in] LPCSTR lpszFile,
[in] int nIconIndex,
[out] HICON *phiconLarge,
[out] HICON *phiconSmall,
UINT nIcons
);
Parameter
[in] lpszFile
Typ: LPCTSTR-
Zeigen Sie auf eine mit Null beendete Zeichenfolge, die den Namen einer ausführbaren Datei, DLL oder Symboldatei angibt, aus der Symbole extrahiert werden.
[in] nIconIndex
Typ: int
Gibt den nullbasierten Index des ersten zu extrahierenden Symbols an. Wenn dieser Wert beispielsweise null ist, extrahiert die Funktion das erste Symbol in der angegebenen Datei.
Wenn dieser Wert -1 und phiconLarge und phiconSmall beide NULLsind, 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 handelt, lautet der Rückgabewert 1.
Wenn dieser Wert eine negative Zahl ist und entweder phiconLarge oder phiconSmall nicht NULL-ist, beginnt die Funktion mit dem Extrahieren des Symbols, dessen Ressourcenbezeichner dem absoluten Wert von nIconIndexentspricht. Verwenden Sie z. B. -3, um das Symbol zu extrahieren, dessen Ressourcenbezeichner 3 ist.
[out] phiconLarge
Typ: HICON*
Zeigen Sie auf ein Array von Symbolziehpunkten, das Handles zu den großen Symbolen empfängt, die aus der Datei extrahiert wurden. Wenn dieser Parameter NULL-ist, werden keine großen Symbole aus der Datei extrahiert.
[out] phiconSmall
Typ: HICON*
Zeigen Sie auf ein Array von Symbolziehpunkten, die Handles an die kleinen Symbole empfängt, die aus der Datei extrahiert wurden. Wenn dieser Parameter NULL-ist, werden keine kleinen Symbole aus der Datei extrahiert.
nIcons
Typ: UINT-
Die Anzahl der Symbole, die aus der Datei extrahiert werden sollen.
Rückgabewert
Typ: UINT-
Wenn der nIconIndex Parameter -1 und sowohl die phiconLarge als auch phiconSmall Parameter NULLsind, ist der Rückgabewert die Anzahl der Symbole in der angegebenen Datei.
Wenn der nIconIndex Parameter ein anderer Wert als -1 ist und entweder phiconLarge oder phiconSmall nicht NULL-ist, ist der Rückgabewert die Anzahl der Symbole, die erfolgreich aus der Datei extrahiert wurden.
Anmerkung
Wenn bei der Funktion ein Fehler auftritt, wird UINT_MAXzurückgegeben. In diesem Fall können Sie GetLastError- aufrufen, um den Fehlercode abzurufen. Diese Funktion gibt beispielsweise UINT_MAX zurück, wenn die durch lpszFile- angegebene Datei nicht gefunden werden kann, während der nIconIndex Parameter ein anderer Wert als -1 ist und entweder phiconLarge oder phiconSmall nicht NULL-ist. In diesem Fall gibt GetLastError-ERROR_FILE_NOT_FOUND (2) zurück.
Bemerkungen
Wenn sie nicht mehr benötigt werden, müssen Sie alle Symbole zerstören, die von ExtractIconEx extrahiert werden, indem Sie die funktion DestroyIcon aufrufen.
Um die Abmessungen der großen und kleinen Symbole abzurufen, verwenden Sie diese Funktion mit den Kennzeichen SM_CXICON, SM_CYICON, SM_CXSMICON und SM_CYSMICON.
Anmerkung
Der shellapi.h-Header definiert ExtractIconEx 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) |