SetConsoleTextAttribute 函数

重要

本文档介绍控制台平台功能，该功能已不再是生态系统蓝图的一部分。我们不建议在新产品中使用此内容，但我们未来将无限期支持现有使用。我们的首选最新解决方案侧重于虚拟终端序列，以实现跨平台方案中的最大兼容性。有关此设计决策的详细信息，请参阅经典控制台与虚拟终端文档。

设置由 WriteFile 或 WriteConsole 函数写入控制台屏幕缓冲区或由 ReadFile 或 ReadConsole 函数回显的字符的属性。此函数会影响在函数调用后写入的文本。

语法

BOOL WINAPI SetConsoleTextAttribute(
  _In_ HANDLE hConsoleOutput,
  _In_ WORD   wAttributes
);

hConsoleOutput [in]
控制台屏幕缓冲区的句柄。该句柄必须具有 GENERIC_READ 访问权限。有关详细信息，请参阅控制台缓冲区安全性和访问权限。

wAttributes [in]
字符属性。

如果该函数成功，则返回值为非零值。

如果函数失败，则返回值为零。要获得更多的错误信息，请调用 GetLastError。

若要确定屏幕缓冲区的当前颜色属性，请调用 GetConsoleScreenBufferInfo 函数。

提示

此 API 在文本格式序列中具有虚拟终端等效项。建议对所有新的和正在进行的开发使用虚拟终端序列。


最低受支持的客户端	Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器	Windows 2000 Server [仅限桌面应用]
Header	ConsoleApi2.h (via WinCon.h, include Windows.h)
库	Kernel32.lib
DLL	Kernel32.dll