ReadConsoleInput 函式
從主控台輸入緩衝區讀取數據，並將它從緩衝區中移除。
語法
BOOL WINAPI ReadConsoleInput(
_In_ HANDLE hConsoleInput,
_Out_ PINPUT_RECORD lpBuffer,
_In_ DWORD nLength,
_Out_ LPDWORD lpNumberOfEventsRead
);
參數
hConsoleInput [in]
主控台輸入緩衝區的句柄。 句柄必須具有 GENERIC_READ 訪問許可權。 如需詳細資訊，請參閱主控台緩衝區安全性和存取權限。
lpBuffer [out]
接收輸入緩衝區數據之INPUT_RECORD結構的陣列指標。
nLength [in]
陣列元素中的 lpBuffer 參數所指向的數位大小。
lpNumberOfEventsRead [out]
接收讀取輸入記錄數目之變數的指標。
傳回值
如果函式成功，則傳回非零的值。
如果此函式失敗，則傳回值為零。 若要取得擴充的錯誤資訊，請呼叫 GetLastError。
備註
如果 nLength 參數中要求的記錄數目超過緩衝區中可用的記錄數目，則會讀取可用的記錄數目。 函式不會傳回，直到至少讀取一個輸入記錄為止。
進程可以在其中 一個等候函 式中指定控制台輸入緩衝區句柄，以判斷何時有未讀取的控制台輸入。 當輸入緩衝區不是空的時，控制台輸入緩衝區句柄的狀態會發出訊號。
若要判斷主控台輸入緩衝區中未讀取的輸入記錄數目，請使用 GetNumberOfConsoleInputEvents 函式。 若要從主控台輸入緩衝區讀取輸入記錄，而不會影響未讀取的記錄數目，請使用 PeekConsoleInput 函式。 若要捨棄主控台輸入緩衝區中的所有未讀取記錄，請使用 FlushConsoleInputBuffer 函 式。
此函式會從主控台的目前字碼頁使用 Unicode 字元或 8 位元字元。 主控台的字碼頁一開始會預設為系統的 OEM 字碼頁。 若要變更控制台的字碼頁，請使用 SetConsoleCP 或 SetConsoleOutputCP 函式。 舊版取用者也可以使用 chcp 或 mode con cp select= 命令，但不建議用於新的開發。
範例
如需範例，請參閱讀取輸入緩衝區事件。
需求
| 最低支援的用戶端 | Windows 2000 Professional [僅限傳統型應用程式] |
| 最低支援的伺服器 | Windows 2000 Server [僅限傳統型應用程式] |
| 頁首 | ConsoleApi.h (透過 WinCon.h，包括 Windows.h) |
| 程式庫 | Kernel32.lib |
| DLL | Kernel32.dll |
| Unicode 和 ANSI 名稱 | ReadConsoleInputW （Unicode） 和 ReadConsoleInputA （ANSI） |