GetLargestConsoleWindowSize 関数

重要

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

現在のフォントとディスプレイのサイズに基づいて、可能な最大のコンソール ウィンドウのサイズを取得します。

構文

COORD WINAPI GetLargestConsoleWindowSize(
  _In_ HANDLE hConsoleOutput
);

パラメーター

hConsoleOutput [in]
コンソール画面バッファーのハンドル。

戻り値

関数が成功した場合、戻り値は、可能な最大のコンソール ウィンドウの文字セル列 (X メンバー) と行 (Y メンバー) の数を指定する COORD 構造体です。 それ以外の場合、構造体のメンバーは 0 です。

詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

この関数では、コンソール スクリーン バッファーのサイズは考慮されません。つまり、返されるウィンドウ サイズは、コンソール スクリーン バッファーのサイズよりも大きくなる可能性があります。 GetConsoleScreenBufferInfo 関数を使用すると、現在の スクリーン バッファー サイズ、現在のフォント、および表示サイズを指定して、コンソール ウィンドウの最大サイズを決定できます。

ヒント

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

要件

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

関連項目

コンソール関数

COORD

GetConsoleScreenBufferInfo

SetConsoleWindowInfo

ウィンドウとスクリーン バッファー サイズ