SetConsoleTextAttribute 関数
- [アーティクル]
-
-
重要
このドキュメントでは、エコシステム ロードマップの一部ではなくなったコンソール プラットフォームの機能について説明します。 このコンテンツを新しい製品で使用することはお勧めしませんが、今後も既存の使用をサポートし続けます。 推奨される最新のソリューションでは、クロスプラットフォーム シナリオでの互換性を最大限に高める仮想ターミナル シーケンスに重点を置いています。 この設計決定の詳細については、クラシック コンソールと仮想ターミナルのドキュメントを参照してください。
WriteFile または WriteConsole 関数によってコンソール画面バッファーに書き込まれる文字、または ReadFile または ReadConsole 関数によってエコーされる文字の属性を設定します。 この関数は、関数呼び出し後に書き込まれたテキストに影響します。
BOOL WINAPI SetConsoleTextAttribute(
_In_ HANDLE hConsoleOutput,
_In_ WORD wAttributes
);
hConsoleOutput [in]
コンソール画面バッファーのハンドル。 ハンドルには、GENERIC_READ アクセス権があります。 詳細については、「コンソール バッファーのセキュリティとアクセス権」を参照してください。
wAttributes [in]
キャラクターの属性。
関数が成功すると、戻り値は 0 以外になります。
関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。
画面バッファーの現在のカラー属性を確認するには、GetConsoleScreenBufferInfo関数を呼び出します。
ヒント
この API には、テキストの書式設定シーケンスに相当する仮想ターミナルがあります。 仮想ターミナル シーケンスは、すべての新規および継続的な開発に推奨されます。
例については、「高レベルの入出力関数の使用」を参照してください。
|
|
サポートされている最小のクライアント |
Windows 2000 Professional [デスクトップ アプリのみ] |
サポートされている最小のサーバー |
Windows 2000 Server [デスクトップ アプリのみ] |
ヘッダー |
ConsoleApi2.h(WinCon.h 経由、Windows.h を含む) |
ライブラリ |
Kernel32.lib |
[DLL] |
Kernel32.dll |
コンソール関数
コンソールの画面バッファー
GetConsoleScreenBufferInfo
ReadConsole
ReadFile
WriteConsole
WriteFile