GetLargestConsoleWindowSize 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 klassischen Konsolendokument im Vergleich zum virtuellen Terminal .

Ruft die Größe des größtmöglichen Konsolenfensters basierend auf der aktuellen Schriftart und dem Schriftgrad der Anzeige ab.

Syntax

COORD WINAPI GetLargestConsoleWindowSize(
  _In_ HANDLE hConsoleOutput
);

Parameter

hConsoleOutput [in]
Ein Handle für den Konsolenbildschirm-Puffer.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert eine COORD-Struktur, die die Anzahl der Zeichenzellenspalten (X-Element) und Zeilen (Y-Element) im größtmöglichen Konsolenfenster angibt. Andernfalls sind die Elemente der Struktur null.

Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Die Funktion berücksichtigt nicht die Größe des Konsolenbildschirmpuffers. Dies bedeutet, dass die zurückgegebene Fenstergröße größer als die Größe des Konsolenbildschirmpuffers sein kann. Die GetConsoleScreenBufferInfo-Funktion kann verwendet werden, um die maximale Größe des Konsolenfensters zu bestimmen, je nach der aktuellen Bildschirmpuffergröße, der aktuellen Schriftart und der Anzeigegröße.

Tipp

Diese API wird nicht empfohlen und verfügt nicht über eine virtuelle Terminalentsprechung. 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 ConsoleApi.h (über WinCon.h, Windows.h einschließen)
Bibliothek Kernel32.lib
DLL Kernel32.dll

Siehe auch

Konsolenfunktionen

COORD

GetConsoleScreenBufferInfo

SetConsoleWindowInfo

Puffergröße von Fenster und Bildschirm