SetConsoleScreenBufferInfoEx関数

重要

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

指定したコンソール画面バッファーに関する拡張情報を設定します。

構文

BOOL WINAPI SetConsoleScreenBufferInfoEx(
  _In_ HANDLE                        hConsoleOutput,
  _In_ PCONSOLE_SCREEN_BUFFER_INFOEX lpConsoleScreenBufferInfoEx
);

パラメーター

hConsoleOutput [in]
コンソール画面バッファーのハンドル。 ハンドルには、GENERIC_WRITE アクセス権が必要です。 詳細については、「コンソール バッファーのセキュリティとアクセス権」を参照してください。

lpConsoleScreenBufferInfoEx [in]
コンソール画面バッファー情報を含むCONSOLE_SCREnterprise EditionN_BUFFER_INFOEX構造体。

戻り値

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

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

解説

ヒント

この API には、同等の部分的 な仮想ターミナル があります。 カーソル配置バッファー と テキスト属性には、同等の特定のシーケンスがあります。 カラー テーブルは構成できませんが、拡張色はコンソール機能で通常使用できる色を超えて使用できます。 ポップアップ属性は、ポップアップ メニューが仮想ターミナルの世界のコマンド ライン クライアント アプリケーションの役割と同等の機能を持ちません。 最後に、ウィンドウのサイズと全画面表示の状態は、仮想ターミナル の世界でユーザーが所有する特権と見なされ、同等のシーケンスはありません。

要件

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

関連項目

コンソール関数

CONSOLE_SCREEN_BUFFER_INFOEX

GetConsoleScreenBufferInfoEx