WriteConsoleOutputCharacter 函数

项目
10/30/2023

重要

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

从指定位置开始，将多个字符复制到控制台屏幕缓冲区的连续单元格。

语法

BOOL WINAPI WriteConsoleOutputCharacter(
  _In_  HANDLE  hConsoleOutput,
  _In_  LPCTSTR lpCharacter,
  _In_  DWORD   nLength,
  _In_  COORD   dwWriteCoord,
  _Out_ LPDWORD lpNumberOfCharsWritten
);

参数

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

lpCharacter [in]
要写入控制台屏幕缓冲区的字符。

nLength [in]
将要写入的字符数。

dwWriteCoord [in]
COORD 结构，指定要将字符写入到的控制台屏幕缓冲区的第一个单元格的字符坐标。

lpNumberOfCharsWritten [出]
指向某个变量的指针，该变量接收实际写入的字符数。

返回值

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

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

注解

如果要写入的字符数量超出了控制台屏幕缓冲区中指定行的末尾，则会将字符写入下一行。如果要写入的字符数量超出了主机屏幕缓冲区的末尾，则会将字符写入控制台屏幕缓冲区的末尾。

写入位置的属性值不会更改。

此函数使用控制台当前代码页中的 Unicode 字符或 8 位字符。控制台的代码页最初默认为系统的 OEM 代码页。若要更改控制台的代码页，请使用 SetConsoleCP 或 SetConsoleOutputCP 函数。旧版使用者也可以使用 chcp 或 mode con cp select= 命令，但不建议将其用于新开发。

提示

此 API 在文本格式和光标定位序列中具有等效的虚拟终端。将光标移动到要插入的位置，应用所需的格式设置，并写出要填充的文本。不同时应用活动颜色格式，就没有向区域发出文本的等效项。此决定有意将 Windows 平台与其他操作系统保持一致，其中单个客户端应用程序应记住其自身的绘制状态以供进一步操作。

要求


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