SetConsoleCursorPosition Funktion

Artikel
12/15/2023

Wichtig

In diesem Dokument werden Konsolenplattformfunktionen beschrieben, die nicht mehr Teil unserer Ökosystem-Roadmap sind. Wir empfehlen nicht, diesen Inhalt in neuen Produkten zu verwenden, aber wir werden weiterhin vorhandene Nutzungen für die unbegrenzte Zukunft unterstützen. Unsere bevorzugte moderne Lösung konzentriert sich auf virtuelle Terminalsequenzen für maximale Kompatibilität in plattformübergreifenden Szenarien. Weitere Informationen zu dieser Designentscheidung finden Sie in unserem Dokument klassische Konsole im Vergleich zum virtuellen Terminal.

Legt die Cursorposition im angegebenen Konsolenbildschirmpuffer fest.

Syntax

BOOL WINAPI SetConsoleCursorPosition(
  _In_ HANDLE hConsoleOutput,
  _In_ COORD  dwCursorPosition
);

Parameter

hConsoleOutput [in]
Ein Handle für den Konsolenbildschirm-Puffer. Das Handle muss über das Zugriffsrecht GENERIC_READ verfügen. Weitere Informationen finden Sie unter Sicherheit und Zugriffsrechte für Konsolenpuffer.

dwCursorPosition [in]
Eine COORD-Struktur, die die neue Cursorposition in Zeichen angibt. Die Koordinaten sind die Spalte und Zeile einer Bildschirmpuffer-Zeichenzelle. Die Koordinaten müssen sich innerhalb der Grenzen des Konsolenbildschirmpuffers befinden.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ungleich Null.

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Die Cursorposition bestimmt, wo Zeichen angezeigt werden, die von der WriteFile- oder WriteConsole-Funktion geschrieben oder von der ReadFile- oder ReadConsole-Funktion wiedergegeben werden. Verwenden Sie die Funktion GetConsoleScreenBufferInfo zum Bestimmen der aktuellen Cursorposition.

Wenn sich die neue Cursorposition nicht innerhalb der Grenzen des Fensters des Konsolenbildschirmpuffers befindet, ändert sich der Fensterursprung, um den Cursor sichtbar zu machen.

Tipp

Diese API verfügt über ein virtuelles Terminal-Äquivalent in den Abschnitten einfache Cursorpositionierung und Cursorpositionierung. Die Verwendung der Zeilen-, Wagenrücklauf-, Rück- und Registersteuerungssequenzen kann auch bei der Cursorpositionierung helfen.

Beispiele

Für ein Beispiel siehe Verwenden der allgemeinen Eingabe- und Ausgabefunktionen.

Anforderungen


Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Header	ConsoleApi2.h (über WinCon.h, Windows.h einschließen)
Bibliothek	Kernel32.lib
DLL	Kernel32.dll