WriteConsoleOutputAttribute関数
重要
このドキュメントでは、エコシステム ロードマップの一部ではなくなったコンソール プラットフォームの機能について説明します。 このコンテンツを新しい製品で使用することはお勧めしませんが、今後も既存の使用をサポートし続けます。 推奨される最新のソリューションでは、クロスプラットフォーム シナリオでの互換性を最大限に高める仮想ターミナル シーケンスに重点を置いています。 この設計決定の詳細については、クラシック コンソールと仮想ターミナルのドキュメントを参照してください。
指定した位置から始まる、コンソール画面バッファーの連続するセルに、多数の文字属性をコピーします。
構文
BOOL WINAPI WriteConsoleOutputAttribute(
_In_ HANDLE hConsoleOutput,
_In_ const WORD *lpAttribute,
_In_ DWORD nLength,
_In_ COORD dwWriteCoord,
_Out_ LPDWORD lpNumberOfAttrsWritten
);
パラメーター
hConsoleOutput [in]
コンソール画面バッファーのハンドル。 ハンドルには、GENERIC_WRITE アクセス権が必要です。 詳細については、「コンソール バッファーのセキュリティとアクセス権」を参照してください。
lpAttribute [in]
コンソール画面バッファーに書き込むときに使用する属性。 詳細については、「文字の属性」を参照してください。
nLength [in]
属性のコピー先となる画面バッファー文字セルの数。
dwWriteCoord [in]
属性の書き込み先となるコンソール画面バッファー内の最初のセルの文字座標を指定する COORD 構造体。
lpNumberOfAttrsWritten [out]
コンソール画面バッファーに実際に書き込まれた属性の数を受け取る変数へのポインター。
戻り値
関数が成功すると、戻り値は 0 以外になります。
関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。
解説
書き込む属性の数がコンソール画面バッファー内の指定された行の末尾を超えて拡張される場合、属性は次の行に書き込まれます。 書き込まれる属性の数がコンソール画面バッファーの末尾を超える場合、属性はコンソール画面バッファーの末尾まで書き込まれます。
書き込まれる位置の文字値は変更されません。
ヒント
この API には、テキストの書式設定とカーソルの配置シーケンスに相当する仮想ターミナルがあります。 カーソルを挿入する場所に移動し、必要な書式を適用して、入力するテキストを書き出します。 テキストも出力せずに領域に色を適用することに相当するものはありません。 この決定により、Windows プラットフォームは、個々のクライアント アプリケーションがそれ自体の描画状態を記憶してさらに操作することが期待される他のオペレーティング システムと意図的に調整されます。
要件
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリのみ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリのみ] |
| ヘッダー | ConsoleApi2.h（WinCon.h 経由、Windows.h を含む） |
| ライブラリ | Kernel32.lib |
| [DLL] | Kernel32.dll |