GetConsoleScreenBufferInfo Funktion

Artikel
12/21/2023

Ruft Informationen über die angegebene Bildlaufleiste ab.

Syntax

BOOL WINAPI GetConsoleScreenBufferInfo(
  _In_  HANDLE                      hConsoleOutput,
  _Out_ PCONSOLE_SCREEN_BUFFER_INFO lpConsoleScreenBufferInfo
);

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.

lpConsoleScreenBufferInfo [out]
Ein Zeiger auf eine CONSOLE_SCREEN_BUFFER_INFO Struktur, die die 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_INFO Struktur zurückgegebene Rechteck kann geändert und dann an die SetConsoleWindowInfo-Funktion übergeben werden, um im Fenster zu scrollen, um die Größe des Fensters oder beides zu ändern.

Alle in der CONSOLE_SCREEN_BUFFER_INFO 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.

Beispiele

Ein Beispiel finden Sie unter Scrollen des Fensters eines Bildschirmpuffers.

Anforderungen


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