FlushConsoleInputBuffer 函式
重要
本文件說明已不再是生態系統 藍圖一部分的控制台平臺功能。 我們不建議您在新產品中使用此內容,但我們將繼續支持無限期的未來現有使用量。 我們慣用的新式解決方案著重於 虛擬終端機序列 ,以在跨平臺案例中達到最大相容性。 您可以在傳統 主控台與虛擬終端機 檔中找到此設計決策的詳細資訊。
排清主控台輸入緩衝區。 目前在輸入緩衝區中的所有輸入記錄都會遭到捨棄。
語法
BOOL WINAPI FlushConsoleInputBuffer(
_In_ HANDLE hConsoleInput
);
參數
hConsoleInput [in]
主控台輸入緩衝區的句柄。 句柄必須具有 GENERIC_WRITE 訪問許可權。 如需詳細資訊,請參閱主控台緩衝區安全性和存取權限。
傳回值
如果函式成功,則傳回非零的值。
如果此函式失敗,則傳回值為零。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。
備註
提示
不建議使用此 API,而且沒有 虛擬終端機 對等專案。 嘗試一次清空輸入佇列,可能會以非預期的方式終結佇列中的狀態。
需求
最低支援的用戶端 | Windows 2000 Professional [僅限傳統型應用程式] |
最低支援的伺服器 | Windows 2000 Server [僅限傳統型應用程式] |
頁首 | ConsoleApi2.h (透過 WinCon.h,包含 Windows.h) |
程式庫 | Kernel32.lib |
DLL | Kernel32.dll |