SetConsoleScreenBufferInfoEx 函数

  • 项目

重要

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

设置有关指定控制台屏幕缓冲区的扩展信息。

语法

BOOL WINAPI SetConsoleScreenBufferInfoEx(
  _In_ HANDLE                        hConsoleOutput,
  _In_ PCONSOLE_SCREEN_BUFFER_INFOEX lpConsoleScreenBufferInfoEx
);

参数

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

lpConsoleScreenBufferInfoEx [in]
包含控制台屏幕缓冲区信息的 CONSOLE_SCREEN_BUFFER_INFOEX 结构。

返回值

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

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

备注

提示

此 API 具有部分虚拟终端等效项。 光标定位缓冲区和文本属性具有特定序列等效项。 颜色表不可配置，但扩展颜色超出了通过控制台功能通常可获得的颜色。 弹出窗口属性没有等效项，因为弹出菜单是命令行客户端应用程序在虚拟终端世界中的责任。 最后，窗口大小和全屏状态被视为用户在虚拟终端世界中拥有的特权，并且没有等效序列。

要求

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

另请参阅

控制台函数

CONSOLE_SCREEN_BUFFER_INFOEX

GetConsoleScreenBufferInfoEx