LoadIconA-Funktion (winuser.h)

Artikel
11/20/2024

Lädt die angegebene Symbolressource aus der ausführbaren Datei (.exe), die einer Anwendungsinstanz zugeordnet ist.

Anmerkung

Diese Funktion wurde durch die LoadImage--Funktion ersetzt (wobei LR_DEFAULTSIZE und LR_SHARED Flags festgelegt sind).

Syntax

HICON LoadIconA(
  [in, optional] HINSTANCE hInstance,
  [in]           LPCSTR    lpIconName
);

Parameter

[in, optional] hInstance

Typ: HINSTANCE-

Ein Handle für das Modul einer DLL- oder ausführbaren Datei (.exe), die das zu ladende Symbol enthält. Weitere Informationen finden Sie unter GetModuleHandle-.

Um ein vordefiniertes Systemsymbol zu laden, legen Sie diesen Parameter auf NULL-fest.

[in] lpIconName

Typ: LPCTSTR-

Wenn hInstance nichtNULL-ist, gibt lpIconName die Symbolressource entweder anhand des Namens oder der Ordnungszahl an. Diese Ordnungszahl muss mithilfe des MAKEINTRESOURCE Makros gepackt werden.

Wenn hInstanceNULL-ist, gibt lpIconName den Bezeichner (beginnend mit dem Präfix IDI_) eines vordefinierten Systemsymbols an, das geladen werden soll.

Rückgabewert

Typ: HICON-

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ein Handle für das neu geladene Symbol.

Wenn die Funktion fehlschlägt, ist der Rückgabewert NULL-. Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten.

Bemerkungen

LoadIcon lädt die Symbolressource nur, wenn sie nicht geladen wurde; andernfalls wird ein Handle für die vorhandene Ressource abgerufen. Die Funktion durchsucht die Symbolressource nach dem Symbol, das für die aktuelle Anzeige am besten geeignet ist. Die Symbolressource kann eine Farb- oder monochrome Bitmap sein.

LoadIcon- kann nur ein Symbol laden, dessen Größe den SM_CXICON und SM_CYICON Systemmetrikwerten entspricht. Verwenden Sie die LoadImage--Funktion, um Symbole anderer Größen zu laden.

Anmerkung

Der winuser.h-Header definiert LoadIcon 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 2000 Professional [nur Desktop-Apps]
mindestens unterstützte Server-	Windows 2000 Server [nur Desktop-Apps]
Zielplattform-	Fenster
Header-	winuser.h (enthalten Windows.h)
Library	User32.lib
DLL-	User32.dll
API-Satz	ext-ms-win-ntuser-gui-l1-1-0 (eingeführt in Windows 8)