GetConsoleDisplayMode 関数

重要

このドキュメントでは、エコシステム ロードマップの一部ではなくなったコンソール プラットフォームの機能について説明します。 このコンテンツを新しい製品で使用することはお勧めしませんが、今後も既存の使用をサポートし続けます。 推奨される最新のソリューションでは、クロスプラットフォーム シナリオでの互換性を最大限に高める仮想ターミナル シーケンスに重点を置いています。 この設計決定の詳細については、クラシック コンソールと仮想ターミナルのドキュメントを参照してください。

現在のコンソールの表示モードを取得します。

構文

BOOL WINAPI GetConsoleDisplayMode(
  _Out_ LPDWORD lpModeFlags
);

パラメーター

lpModeFlags [out]
コンソールの表示モード。 このパラメーターには、次の値のいずれかを指定できます。

Value	意味
CONSOLE_FULLSCREEN 1	全画面表示コンソール。 ウィンドウが最大化されるとすぐに、コンソールはこのモードになります。 この時点で、全画面モードへの切り替えは失敗する可能性があります。
CONSOLE_FULLSCREEN_HARDWARE 2	ビデオ ハードウェアと直接通信する全画面表示コンソール。 このモードは、コンソールが CONSOLE_FULLSCREEN モードになった後に設定され、全画面モードへの切り替えが完了したことを示します。

Note

100% 全画面表示ビデオ ハードウェア モードへの切り替えは、グラフィックス スタックを WDDM に再プラットフォーム化して Windows Vista で削除されました。 それ以降のバージョンの Windows では、結果の最大状態は CONSOLE_FULLSCREEN であり、全画面表示で表示されるが、ハードウェアの排他的な制御には含まれていないフレームレス ウィンドウを表します。

戻り値

関数が成功すると、戻り値は 0 以外になります。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

この関数を使用するアプリケーションをコンパイルするには、_WIN32_WINNTを0x0500 以降として定義します。 詳細については、「Windows ヘッダーの使用」を参照してください。

ヒント

この API は推奨されておらず、同等の 仮想ターミナル はありません。 この決定により、Windows プラットフォームは、ユーザーがこのプレゼンテーション オプションを完全に制御できる他のオペレーティング システムと意図的に調整されます。 この API を使用している場合、クロスプラットフォーム ユーティリティや SSH などのトランスポートを介したアプリケーションのリモート処理は、想定どおりに動作しない可能性があります。

要件

サポートされている最小のクライアント	Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー	Windows Server 2003 (デスクトップ アプリのみ)
ヘッダー	ConsoleApi3.h（WinCon.h 経由、Windows.h を含む）
ライブラリ	Kernel32.lib
[DLL]	Kernel32.dll

関連項目

コンソール関数

コンソール モード

SetConsoleDisplayMode