SetConsoleCursorInfo 函数

  • 项目

重要

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

为指定的控制台屏幕缓冲区设置光标的大小和可见性。

语法

BOOL WINAPI SetConsoleCursorInfo(
  _In_       HANDLE              hConsoleOutput,
  _In_ const CONSOLE_CURSOR_INFO *lpConsoleCursorInfo
);

参数

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

lpConsoleCursorInfo [in]
指向 CONSOLE_CURSOR_INFO 结构的指针，该结构为控制台屏幕缓冲区的光标提供新的规范。

返回值

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

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

备注

当屏幕缓冲区的光标可见时，其外观可以变化，范围从占满字符单元到显示为单元格底部的横线。 CONSOLE_CURSOR_INFO 结构的 dwSize 成员指定由光标填充的字符单元的百分比。 如果此成员小于 1 或大于 100，则 SetConsoleCursorInfo 将失败。

提示

此 API 在光标可见性部分中具有虚拟终端等效项，其中包含 ^[[?25h 和 ^[[?25l 序列。

要求

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

另请参阅

控制台函数

控制台屏幕缓冲区

CONSOLE_CURSOR_INFO

GetConsoleCursorInfo

SetConsoleCursorPosition