SetConsoleScreenBufferSize 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.

Ändert die Größe des angegebenen Bildschirmpuffers der Konsole.

Syntax

BOOL WINAPI SetConsoleScreenBufferSize(
  _In_ HANDLE hConsoleOutput,
  _In_ COORD  dwSize
);

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.

dwSize [in]
Eine COORD-Struktur, die die neue Größe des Konsolenbildschirmpuffers in Zeichenzeilen und Spalten angibt. Die angegebene Breite und Höhe darf nicht kleiner als die Breite und Höhe des Fensters des Konsolenbildschirmpuffers sein. Die angegebenen Dimensionen dürfen auch nicht kleiner sein als die vom System zulässige Mindestgröße. Dieses Minimum hängt vom aktuellen Schriftgrad für die Konsole (ausgewählt vom Benutzer) und den von der GetSystemMetrics-Funktion zurückgegebenen SM_CXMIN- und SM_CYMIN-Werten ab.

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

Tipp

Diese API wird nicht empfohlen und verfügt nicht über eine virtuelle Terminal-Entsprechung. Diese Entscheidung richtet die Windows-Plattform absichtlich mit anderen Betriebssystemen aus, auf denen dem Benutzer die volle Kontrolle über diese Präsentationsoption gewährt wird. Anwendungen, die über plattformübergreifende Dienstprogramme und Transporte wie SSH remoten, funktionieren möglicherweise nicht wie erwartet, wenn Sie diese API verwenden.

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

Konsoleneingabepuffer

COORD

GetConsoleScreenBufferInfo

SetConsoleWindowInfo