FillConsoleOutputAttribute 函数

重要

本文档介绍了不再属于 生态系统路线图的控制台平台功能。 我们不建议在新产品中使用此内容,但我们将继续支持现有的现有使用量。 我们首选的新式解决方案侧重于 虚拟终端序列 ,以实现跨平台方案中的最大兼容性。 有关此设计决策的详细信息,请在 经典控制台与虚拟终端 文档中找到。

从屏幕缓冲区中的指定坐标开始,为指定数量的字符单元格设置字符特性。

语法

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

参数

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

wAttribute [in]
写入控制台屏幕缓冲区时要使用的属性。 有关详细信息,请参阅 字符特性

nLength [in]
要设置为指定颜色属性的字符单元格数。

dwWriteCoord [in]
Oozie.coord.application.path结构,指定要设置其属性的第一个单元格的字符坐标。

lpNumberOfAttrsWritten [out]
指向一个变量的指针,该变量接收实际设置了其属性的字符单元格的数目。

返回值

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

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

备注

如果要设置其属性的字符单元格数超出了控制台屏幕缓冲区中指定行的末尾,则会设置下一行的单元格。 如果要写入的单元格数超出了控制台屏幕缓冲区的末尾,则将单元格写入控制台屏幕缓冲区的末尾。

不会更改写入位置的字符值。

提示

不建议使用此 API,也不会有特定的 虚拟终端 等效项。 不支持在可视窗口之外填充区域,而是将其保留给终端的历史记录空间。 通过 移动光标设置新属性,然后为该区域写入所需的文本,并在填充运行长度需要时为其重复字符,使用新文本或颜色填充可见区域。 可能需要执行其他游标移动,然后再编写所需的文本来填充矩形区域。 客户端应用程序应该保留其自己的内存(在屏幕上),并且无法查询远程状态。 有关详细信息,请参阅 经典控制台和虚拟终端 文档。

要求

   
最低受支持的客户端 Windows 2000 Professional [仅限桌面应用]
最低受支持的服务器 Windows 2000 Server [仅限桌面应用]
标头 ConsoleApi2 通过 WinCon (包含 Windows .h)
Kernel32.lib
DLL Kernel32.dll

另请参阅

控制台函数

OOZIE.COORD.APPLICATION.PATH

FillConsoleOutputCharacter

低级别控制台输出函数

SetConsoleTextAttribute

WriteConsoleOutputAttribute