WriteConsoleInput 函式
重要
本檔說明已不再是生態系統 藍圖 一部分的主控台平臺功能。 我們不建議您在新產品中使用此內容,但我們將繼續支援無限期的未來現有使用量。 我們慣用的新式解決方案著重于 虛擬終端機序列 ,以在跨平臺案例中達到最大相容性。 您可以在傳統 主控台與虛擬終端機 檔中找到此設計決策的詳細資訊。
將資料直接寫入主控台輸入緩衝區。
語法
BOOL WINAPI WriteConsoleInput(
_In_ HANDLE hConsoleInput,
_In_ const INPUT_RECORD *lpBuffer,
_In_ DWORD nLength,
_Out_ LPDWORD lpNumberOfEventsWritten
);
參數
hConsoleInput [in]
主控台輸入緩衝區的控制碼。 控制碼必須具有 GENERIC_WRITE 存取權限。 如需詳細資訊,請參閱主控台緩衝區安全性和存取權限。
lpBuffer [in]
包含要寫入輸入緩衝區之資料的INPUT_RECORD 結構的陣列 指標。
nLength [in]
要寫入的輸入記錄數目。
lpNumberOfEventsWritten [out]
接收實際寫入之輸入記錄數目的變數指標。
傳回值
如果函式成功,則傳回非零的值。
如果此函式失敗,則傳回值為零。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。
備註
WriteConsoleInput 會將輸入記錄放入緩衝區中任何暫止事件後方的輸入緩衝區。 視需要,輸入緩衝區會以動態方式成長,以保留所寫入的事件數目。
此函式會從主控台的目前字碼頁使用 Unicode 字元或 8 位元字元。 主控台的字碼頁一開始會預設為系統的 OEM 字碼頁。 若要變更控制台的字碼頁,請使用 SetConsoleCP 或 SetConsoleOutputCP 函式。 舊版取用者也可以使用 chcp 或 mode con cp select= 命令,但不建議用於新的開發。
提示
不建議使用此 API,而且沒有 虛擬終端機 對等專案。 此決策會刻意將 Windows 平臺與其他作業系統對齊。 此作業被視為 這個緩衝區的錯誤方式動詞 。 透過跨平臺公用程式和 SSH 之類的傳輸進行遠端處理的應用程式在使用這個 API 時可能無法如預期般運作。
需求
最低支援的用戶端 | Windows 2000 Professional [僅限傳統型應用程式] |
最低支援的伺服器 | Windows 2000 Server [僅限傳統型應用程式] |
頁首 | ConsoleApi2.h (透過 WinCon.h,包含 Windows.h) |
程式庫 | Kernel32.lib |
DLL | Kernel32.dll |
Unicode 和 ANSI 名稱 | WriteConsoleInputW (Unicode) 和 WriteConsoleInputA (ANSI) |