GetConsoleScreenBufferInfoEx Funktion

  • Artikel

Ruft erweiterte Informationen zum angegebenen Konsolenbildschirmpuffer ab.

Syntax

BOOL WINAPI GetConsoleScreenBufferInfoEx(
  _In_  HANDLE                        hConsoleOutput,
  _Out_ PCONSOLE_SCREEN_BUFFER_INFOEX lpConsoleScreenBufferInfoEx
);

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.

lpConsoleScreenBufferInfoEx [out]
Eine CONSOLE_SCREEN_BUFFER_INFOEX Struktur, die die angeforderten Informationen zum Konsolenbildschirmpuffer empfängt.

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

Das im srWindow-Element der CONSOLE_SCREEN_BUFFER_INFOEX-Struktur zurückgegebene Rechteck kann geändert und dann an die SetConsoleWindowInfo-Funktion übergeben werden, um den Konsolenbildschirmpuffer im Fenster zu scrollen, um die Größe des Fensters oder beides zu ändern.

Alle in der CONSOLE_SCREEN_BUFFER_INFOEX Struktur zurückgegebenen Koordinaten befinden sich in Zeichenzellenkoordinaten, wobei sich der Ursprung (0, 0) in der oberen linken Ecke des Konsolenbildschirmpuffers befindet.

Tipp

Diese API verfügt nicht über ein virtuelles Terminaläquivalent. Die Verwendung ist möglicherweise weiterhin für Anwendungen erforderlich, die versuchen, Spalten, Raster zu zeichnen oder die Anzeige auszufüllen, um die Fenstergröße abzurufen. Dieser Fensterzustand wird von der TTY/PTY/Pseudoconsole außerhalb des normalen Datenstromflusses verwaltet und gilt im Allgemeinen als Benutzerberechtigungen, die von der Clientanwendung nicht anpassbar sind. Updates können auf ReadConsoleInput empfangen werden.

Anforderungen

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

Siehe auch

Konsolenfunktionen

CONSOLE_SCREEN_BUFFER_INFOEX

SetConsoleScreenBufferInfoEx