FlushConsoleInputBuffer 函数

重要

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

刷新控制台输入缓冲区。当前在输入缓冲区中的所有输入记录将被丢弃。

语法

BOOL WINAPI FlushConsoleInputBuffer(
  _In_ HANDLE hConsoleInput
);

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

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

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

提示

不建议使用此 API，并且此 API 没有等效的虚拟终端。尝试一次性清空输入队列可能会以意外的方式破坏队列中的状态。


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