SetConsoleCursorPosition 函数

重要

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

设置指定控制台屏幕缓冲区中的光标位置。

语法

BOOL WINAPI SetConsoleCursorPosition(
  _In_ HANDLE hConsoleOutput,
  _In_ COORD  dwCursorPosition
);

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

dwCursorPosition [in]
指定新光标位置（以字符为单位）的 COORD 结构。坐标是屏幕缓冲区字符单元的列和行。坐标必须位于控制台屏幕缓冲区的边界以内。

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

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

光标位置决定 WriteFile 或 WriteConsole 函数写入或者 ReadFile 或 ReadConsole 函数回显的字符显示在哪里。要确定光标的当前位置，请使用 GetConsoleScreenBufferInfo 函数。

如果新光标位置不在控制台屏幕缓冲区窗口的边界内，则窗口原点将变化以使光标可见。

提示

此 API 在简单光标定位和光标定位部分中具有虚拟终端等效项。使用换行、回车、退格和制表符控件序列也有助于定位光标。


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