SetConsoleTextAttribute

WriteFile/WriteConsole で書き込まれる、または ReadFile/ReadConsole でエコーされる文字の属性をコンソール画面バッファに設定する。

SetConsoleTextAttribute hConsoleOutput, wAttributes

hConsoleOutput : [intptr] コンソール画面バッファへのハンドル。ハンドルには **GENERIC\_READ** アクセス権が必要である。詳細は [コンソールバッファのセキュリティとアクセス権](console-buffer-security-and-access-rights.md) を参照。
wAttributes : [int] [文字属性](console-screen-buffers.md#character-attributes)。

(プラグイン / モジュール : kernel32.dll)

解説

WriteFile/WriteConsole で書き込まれる、または ReadFile/ReadConsole
でエコーされる文字の属性をコンソール画面バッファに設定する。

[戻り値]
関数が成功した場合、戻り値は非ゼロである。失敗した場合はゼロである。拡張エラー情報を取得するには
[**GetLastError**](/windows/win32/api/errhandlingapi/nf-errhandlingapi-getlasterror)
を呼び出す。

[備考]
画面バッファの現在のカラー属性を取得するには
[**GetConsoleScreenBufferInfo**](getconsolescreenbufferinfo.md)
を呼び出す。> [!TIP] > この API は
**[仮想ターミナル](console-virtual-terminal-sequences.md)** の
**[テキスト整形](console-virtual-terminal-sequences.md#text-formatting)**
シーケンスに相当する。新規・継続的な開発には _仮想ターミナルシーケンス_ が推奨される。

情報