ExtractIconW-Funktion (shellapi.h)

  • Artikel

Ruft ein Handle für ein Symbol aus der angegebenen ausführbaren Datei, DLL oder Symboldatei ab.

Verwenden Sie die ExtractIconEx-Funktion , um ein Array von Handles für große oder kleine Symbole abzurufen.

Syntax

HICON ExtractIconW(
  [in] HINSTANCE hInst,
  [in] LPCWSTR   pszExeFileName,
       UINT      nIconIndex
);

Parameter

[in] hInst

Typ: HINSTANCE

Handle an die instance der Anwendung, die die Funktion aufruft.

[in] pszExeFileName

Typ: LPCTSTR

Zeiger auf eine NULL-endende 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 die Datei eine ist. 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 nIconIndex entspricht. Sie sollten beispielsweise –3 verwenden, um das Symbol zu extrahieren, dessen Ressourcenbezeichner 3 ist. Verwenden Sie die ExtractIconEx-Funktion , um das Symbol zu extrahieren, dessen Ressourcenbezeichner 1 ist.

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, ist die Rückgabe 1. Wenn in der Datei keine Symbole gefunden wurden, ist der Rückgabewert NULL.

Hinweise

Wenn es nicht mehr benötigt wird, müssen Sie das von ExtractIcon zurückgegebene Symbolhandle zerstören, indem Sie die DestroyIcon-Funktion aufrufen.

Hinweis

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
Unterstützte Mindestversion (Client) Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows 2000 Server [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile shellapi.h
DLL Shell32.dll
APIs ext-ms-win-shell-shell32-l1-2-1 (eingeführt in Windows 10, Version 10.0.10240)

Weitere Informationen

ExtractAssociatedIcon

ExtractAssociatedIconEx

ExtractIconEx