PeekConsoleInput 函式
從指定的主控台輸入緩衝區讀取資料,而不需要從緩衝區中移除它。
語法
BOOL WINAPI PeekConsoleInput(
_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。
備註
如果要求的記錄數目超過緩衝區中可用的記錄數目,則會讀取可用的記錄數目。 如果沒有可用的數據,函式會立即傳回。
此函式會從主控台的目前字碼頁使用 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 名稱 | PeekConsoleInputW (Unicode) 和 PeekConsoleInputA (ANSI) |