SetConsoleDisplayMode関数
重要
このドキュメントでは、エコシステム ロードマップの一部ではなくなったコンソール プラットフォームの機能について説明します。 このコンテンツを新しい製品で使用することはお勧めしませんが、今後も既存の使用をサポートし続けます。 推奨される最新のソリューションでは、クロスプラットフォーム シナリオでの互換性を最大限に高める仮想ターミナル シーケンスに重点を置いています。 この設計決定の詳細については、クラシック コンソールと仮想ターミナルのドキュメントを参照してください。
指定したコンソール画面バッファーの表示モードを設定します。
構文
BOOL WINAPI SetConsoleDisplayMode(
_In_ HANDLE hConsoleOutput,
_In_ DWORD dwFlags,
_Out_opt_ PCOORD lpNewScreenBufferDimensions
);
パラメーター
hConsoleOutput [in]
コンソール画面バッファーのハンドル。
dwFlags [in]
コンソールの表示モード。 このパラメーターには、次の値のいずれかを指定できます。
Value | 意味 |
---|---|
CONSOLE_FULLSCREEN_MODE 1 | テキストは全画面表示モードで表示されます。 |
CONSOLE_WINDOWED_MODE 2 | テキストがコンソール ウィンドウに表示されます。 |
lpNewScreenBufferDimensions [out, optional]
画面バッファーの 新しい次元を文字で受け取る COORD 構造体へのポインター。
戻り値
関数が成功すると、戻り値は 0 以外になります。
関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。
解説
ヒント
この API は推奨されておらず、同等の 仮想ターミナル はありません。 この決定により、Windows プラットフォームは、ユーザーがこのプレゼンテーション オプションを完全に制御できる他のオペレーティング システムと意図的に調整されます。 この API を使用している場合、クロスプラットフォーム ユーティリティや SSH などのトランスポートを介したアプリケーションのリモート処理は、想定どおりに動作しない可能性があります。
要件
サポートされている最小のクライアント | Windows XP (デスクトップ アプリのみ) |
サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
ヘッダー | ConsoleApi3.h(WinCon.h 経由、Windows.h を含む) |
ライブラリ | Kernel32.lib |
[DLL] | Kernel32.dll |