GetConsoleSelectionInfo 函数

重要

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

检索有关当前控制台选择项的信息。

语法

BOOL WINAPI GetConsoleSelectionInfo(
  _Out_ PCONSOLE_SELECTION_INFO lpConsoleSelectionInfo
);

参数

lpConsoleSelectionInfo [out]
指向 CONSOLE_SELECTION_INFO 结构的指针，它会接收选择项信息。

返回值

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

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

注解

若要编译使用此函数的应用程序，请将 _WIN32_WINNT 定义为 0x0500 或更高版本。 有关详细信息，请参阅使用 Windows 标头。

提示

不建议使用此 API，并且此 API 没有虚拟终端等效项。 此决策有意使 Windows 平台与其他操作系统保持一致，在这些操作系统中，用户可以完全控制此演示选项。 如果使用此 API，则通过跨平台实用工具和传输（例如 SSH）进行远程处理的应用程序可能无法正常工作。

要求

最低受支持的客户端	Windows XP [仅限桌面应用]
最低受支持的服务器	Windows Server 2003 [仅限桌面应用]
标头	ConsoleApi3.h (via WinCon.h, include Windows.h)
库	Kernel32.lib
DLL	Kernel32.dll

另请参阅

控制台函数

控制台选择

CONSOLE_SELECTION_INFO