SetConsoleActiveScreenBuffer 関数

重要

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

指定したスクリーン バッファーを、現在表示されているコンソール スクリーン バッファーに設定します。

構文

BOOL WINAPI SetConsoleActiveScreenBuffer(
  _In_ HANDLE hConsoleOutput
);

パラメーター

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

戻り値

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

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

解説

コンソールには複数の画面バッファーを持たせることができます。 SetConsoleActiveScreenBuffer によって、表示されるオブジェクトが決まります。 非アクティブなスクリーン バッファーに書き込み、SetConsoleActiveScreenBuffer を使用してバッファーの内容を表示できます。

ヒント

この API は推奨されませんが、代替スクリーン バッファーシーケンスに相当するおおよその仮想ターミナルがあります。 代替スクリーン バッファーを設定すると、アプリケーションの呼び出し側によって表示されたコンテンツを保持しながら、セッション ランタイムの過程で描画するための独立した分離スペースをアプリケーションに提供できます。 これは、プロセス終了時に簡単に復元するための描画情報を維持します。

例

例については、「文字と属性のブロックの読み取りと書き込み」を参照してください。

要件

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

関連項目

コンソール関数

コンソールの画面バッファー

CreateConsoleScreenBuffer