SetConsoleCursorInfo Funktion

  • Artikel

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 Größe und Sichtbarkeit des Cursors für den angegebenen Konsolenbildschirmpuffer fest.

Syntax

BOOL WINAPI SetConsoleCursorInfo(
  _In_       HANDLE              hConsoleOutput,
  _In_ const CONSOLE_CURSOR_INFO *lpConsoleCursorInfo
);

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.

lpConsoleCursorInfo [in]
Ein Zeiger auf eine CONSOLE_CURSOR_INFO Struktur, die die neuen Spezifikationen für den Cursor des Konsolenbildschirmpuffers bereitstellt.

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

Wenn der Cursor eines Bildschirmpuffers sichtbar ist, kann seine Darstellung abweichen, beginnend mit dem vollständigen Ausfüllen einer Zeichenzelle bis hin zur Darstellung als horizontale Linie an der Zellunterkante. Das dwSize-Mitglied der CONSOLE_CURSOR_INFO-Struktur gibt den Prozentsatz einer Zeichenzelle an, die vom Cursor gefüllt wird. Wenn dieses Mitglied kleiner als 1 oder größer als 100 ist, schlägt SetConsoleCursorInfo fehl.

Tipp

Diese API verfügt über eine virtuelle Terminal-Entsprechung im AbschnittCursorsichtbarkeit mit den ^[[?25h und ^[[?25l Sequenzen.

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

Siehe auch

Konsolenfunktionen

Konsolenbildschirmpuffer

CONSOLE_CURSOR_INFO

GetConsoleCursorInfo

SetConsoleCursorPosition