GetNumberOfConsoleMouseButtons 函数

重要

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

检索当前控制台所使用的鼠标上的按钮数。

语法

BOOL WINAPI GetNumberOfConsoleMouseButtons(
  _Out_ LPDWORD lpNumberOfMouseButtons
);

参数

lpNumberOfMouseButtons [out]
指向变量的指针,该变量可接收鼠标按钮数。

返回值

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

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

备注

当控制台收到鼠标输入时,包含 MOUSE_EVENT_RECORD 结构的 INPUT_RECORD 结构会放置在控制台的输入缓冲区中。 MOUSE_EVENT_RECORDdwButtonState 成员有一个指示每个鼠标按钮状态的位。 如果按下按钮,则该位为 1;如果松开按钮,则为 0。 若要确定重要的位数,请使用 GetNumberOfConsoleMouseButtons

提示

不建议使用此 API,并且此 API 没有虚拟终端等效项。 此决策有意使 Windows 平台与其他操作系统保持一致。 此状态仅与本地用户、会话以及特权上下文相关。 如果使用此 API,则通过跨平台实用工具和传输(例如 SSH)进行远程处理的应用程序可能无法正常工作。

要求

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

另请参阅

控制台函数

控制台输入缓冲区

ReadConsoleInput

INPUT_RECORD

MOUSE_EVENT_RECORD