GetNumberOfConsoleInputEvents 函式
擷取控制台輸入緩衝區中未讀取的輸入記錄數目。
語法
BOOL WINAPI GetNumberOfConsoleInputEvents(
_In_ HANDLE hConsoleInput,
_Out_ LPDWORD lpcNumberOfEvents
);
參數
hConsoleInput [in]
主控台輸入緩衝區的句柄。 句柄必須具有 GENERIC_READ 訪問許可權。 如需詳細資訊,請參閱主控台緩衝區安全性和存取權限。
lpcNumberOfEvents [out]
變數的指標,這個變數會接收控制台輸入緩衝區中未讀取的輸入記錄數目。
傳回值
如果函式成功,則傳回非零的值。
如果此函式失敗,則傳回值為零。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。
備註
GetNumberOfConsoleInputEvents 函式會報告輸入緩衝區中未讀取的輸入記錄總數,包括鍵盤、滑鼠和視窗重設大小輸入記錄。 使用 ReadFile 或 ReadConsole 函式的進程只能讀取鍵盤輸入。 使用 ReadConsoleInput 函式的進程可以讀取所有類型的輸入記錄。
進程可以在其中 一個等候函 式中指定控制台輸入緩衝區句柄,以判斷何時有未讀取的控制台輸入。 當輸入緩衝區不是空的時,控制台輸入緩衝區句柄的狀態會發出訊號。
若要從主控台輸入緩衝區讀取輸入記錄,而不會影響未讀取的記錄數目,請使用 PeekConsoleInput 函式。 若要捨棄主控台輸入緩衝區中的所有未讀取記錄,請使用 FlushConsoleInputBuffer 函 式。
需求
最低支援的用戶端 | Windows 2000 Professional [僅限傳統型應用程式] |
最低支援的伺服器 | Windows 2000 Server [僅限傳統型應用程式] |
頁首 | ConsoleApi.h (透過 WinCon.h,包括 Windows.h) |
程式庫 | Kernel32.lib |
DLL | Kernel32.dll |