FillConsoleOutputAttribute 関数

重要

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

スクリーン バッファー内の指定した座標から始まる、指定した数の文字セルの文字属性を設定します。

構文

BOOL WINAPI FillConsoleOutputAttribute(
  _In_  HANDLE  hConsoleOutput,
  _In_  WORD    wAttribute,
  _In_  DWORD   nLength,
  _In_  COORD   dwWriteCoord,
  _Out_ LPDWORD lpNumberOfAttrsWritten
);

パラメーター

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

wAttribute [in]
コンソール スクリーン バッファーに書き込むときに使用する属性。 詳細については、「文字の属性」を参照してください。

nLength [in]
指定した色属性に設定する文字セルの数。

dwWriteCoord [in]
属性が設定される最初のセルの文字座標を指定する COORD 構造体。

lpNumberOfAttrsWritten [out]
属性が実際に設定された文字セルの数を受信する変数のポインター。

戻り値

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

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

解説

設定する属性の文字セルの数がコンソール スクリーン バッファー内の指定された行の末尾を超えて拡張される場合、次の行のセルが設定されます。 書き込むセルの数がコンソール スクリーン バッファーの末尾を超える場合、セルはコンソール スクリーン バッファーの末尾まで書き込まれます。

書き込まれる位置の文字値は変更されません。

ヒント

この API は推奨されておらず、同等の特定の 仮想ターミナル はありません。 表示可能ウィンドウの外側の領域への入力はサポートされておらず、ターミナルの履歴スペース用に予約されています。 表示領域に新しいテキストまたは色を入力するには、カーソルの移動、新しい属性の設定を行い、その後その領域の目的のテキストの書き込み、塗りつぶしの実行の長さに必要に応じて文字の繰り返しを行います。 追加のカーソル移動の後に、四角形の領域を塗りつぶすために目的のテキストを書き込む必要があります。 クライアント アプリケーションは、スクリーン上にあるものの独自のメモリを保持し、リモート状態のクエリを実行できないことが予想されます。 詳細については、クラシック コンソールと仮想ターミナルのドキュメントを参照してください。

要件

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

関連項目

コンソール関数

COORD

FillConsoleOutputCharacter

低レベル コンソール出力関数

SetConsoleTextAttribute

WriteConsoleOutputAttribute