SetConsoleDisplayMode-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 den Anzeigemodus des angegebenen Konsolenbildschirmpuffers fest.

Syntax

BOOL WINAPI SetConsoleDisplayMode(
  _In_      HANDLE hConsoleOutput,
  _In_      DWORD  dwFlags,
  _Out_opt_ PCOORD lpNewScreenBufferDimensions
);

Parameter

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

dwFlags [in]
Der Anzeigemodus der Konsole. Dieser Parameter kann einen oder mehrere der folgenden Werte annehmen.

Wert Bedeutung
CONSOLE_FULLSCREEN_MODE 1 Text wird im Vollbildmodus angezeigt.
CONSOLE_WINDOWED_MODE 2 Text wird in einem Konsolenfenster angezeigt.

lpNewScreenBufferDimensions [out, optional]
Ein Zeiger auf eine COORD-Struktur, die die neuen Dimensionen des Bildschirmpuffers in Zeichen 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

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 XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2003 [nur Desktop-Apps]
Header ConsoleApi3.h (über WinCon.h, Windows.h einschließen)
Bibliothek Kernel32.lib
DLL Kernel32.dll

Siehe auch

Konsolenfunktionen

Konsolenmodi

GetConsoleDisplayMode