LoadCursorA-Funktion (winuser.h)

Artikel
08/27/2023

Lädt die angegebene Cursorressource aus der ausführbaren Datei (.EXE), die einer Anwendung instance zugeordnet ist.

Hinweis

Diese Funktion wurde von der LoadImage-Funktion abgelöst (mit LR_DEFAULTSIZE- und LR_SHARED-Flags).

Syntax

HCURSOR LoadCursorA(
  [in, optional] HINSTANCE hInstance,
  [in]           LPCSTR    lpCursorName
);

Parameter

[in, optional] hInstance

Typ: HINSTANCE

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

Um einen vordefinierten Systemcursor zu laden, legen Sie diesen Parameter auf NULL fest.

[in] lpCursorName

Typ: LPCTSTR

Wenn hInstance ungleich NULL ist, gibt lpCursorName die Cursorressource entweder anhand des Namens oder der Ordnungszahl an. Diese Ordnungszahl muss mithilfe des MAKEINTRESOURCE-Makros verpackt werden.

Wenn hInstanceNULL ist, gibt lpCursorName den Bezeichner (beginnend mit dem IDC_ Präfix) eines zu ladenden vordefinierten Systemcursors an.

Rückgabewert

Typ: HCURSOR

Wenn die Funktion erfolgreich ist, ist der Rückgabewert das Handle für den neu geladenen Cursor.

Wenn bei der Funktion ein Fehler auftritt, ist der Rückgabewert NULL. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Die LoadCursor-Funktion lädt die Cursorressource nur, wenn sie nicht geladen wurde. Andernfalls wird das Handle für die vorhandene Ressource abgerufen. Diese Funktion gibt nur dann ein gültiges Cursorhandle zurück, wenn der parameter lpCursorName ein Zeiger auf eine Cursorressource ist. Wenn lpCursorName ein Zeiger auf einen anderen Ressourcentyp als einen Cursor (z. B. ein Symbol) ist, ist der Rückgabewert nicht NULL, obwohl es sich nicht um ein gültiges Cursorhandle handelt.

Die LoadCursor-Funktion durchsucht die Cursorressource, die für den Cursor für das aktuelle Anzeigegerät am besten geeignet ist. Die Cursorressource kann eine Farb- oder monochrome Bitmap sein.

DPI-Virtualisierung

Diese API ist nicht an der DPI-Virtualisierung beteiligt. Die zurückgegebene Ausgabe wird vom DPI-Wert des aufrufenden Threads nicht beeinflusst.

Beispiele

Ein Beispiel finden Sie unter Erstellen eines Cursors.

Hinweis

Der winuser.h-Header definiert LoadCursor 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


Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	winuser.h (windows.h einschließen)
Bibliothek	User32.lib
DLL	User32.dll