WriteConsoleOutputCharacter 函式
重要
本檔說明不再屬於 生態系統藍圖的主控台平臺功能。 我們不建議在新產品中使用此內容,但我們將會在未來持續支援現有的使用方式。 我們慣用的新式解決方案著重于 虛擬終端機序列 ,以在跨平臺案例中達到最大相容性。 您可以在傳統 主控台與虛擬終端機 檔中找到此設計決策的詳細資訊。
從指定的位置開始,將數個字元複製到主控台畫面緩衝區的連續儲存格。
語法
BOOL WINAPI WriteConsoleOutputCharacter(
_In_ HANDLE hConsoleOutput,
_In_ LPCTSTR lpCharacter,
_In_ DWORD nLength,
_In_ COORD dwWriteCoord,
_Out_ LPDWORD lpNumberOfCharsWritten
);
參數
hConsoleOutput [in]
主控台螢幕緩衝區的控點。 控制碼必須具有 GENERIC_WRITE 存取權限。 如需詳細資訊,請參閱主控台緩衝區安全性和存取權限。
lpCharacter [in]
要寫入主控台畫面緩衝區的字元。
nLength [in]
要寫入的字元數。
dwWriteCoord [in]
COORD結構,指定要寫入字元之主控台畫面緩衝區中第一個儲存格的字元座標。
lpNumberOfCharsWritten [out]
變數的指標,可接收實際寫入的字元數。
傳回值
如果函式成功,則傳回非零的值。
如果此函式失敗,則傳回值為零。 若要取得擴充的錯誤資訊,請呼叫 GetLastError。
備註
如果要寫入的字元數超出主控台畫面緩衝區中指定資料列結尾的長度,則會將字元寫入下一個資料列。 如果要寫入的字元數超出主控台畫面緩衝區的結尾,則字元會寫入主控台畫面緩衝區的結尾。
寫入位置的屬性值不會變更。
此函式會從主控台的目前字碼頁使用 Unicode 字元或 8 位元字元。 主控台的字碼頁一開始會預設為系統的 OEM 字碼頁。 若要變更控制台的字碼頁,請使用 SetConsoleCP 或 SetConsoleOutputCP 函式。 舊版取用者也可以使用 chcp 或 mode con cp select= 命令,但不建議用於新的開發。
提示
此 API 在文字格式設定和游標定位序列中具有對等的虛擬終端機。 將游標移至要插入的位置、套用所需的格式設定,以及寫出要填滿的文字。 不需要同時套用使用中色彩格式設定,就不等於將文字發出至區域。 此決策會刻意讓 Windows 平臺與其他作業系統保持一致,其中個別用戶端應用程式預期會記住自己的繪製狀態,以進行進一步操作。
規格需求
最低支援的用戶端 | Windows 2000 Professional [僅限傳統型應用程式] |
最低支援的伺服器 | Windows 2000 Server [僅限桌面應用程式] |
標頭 | ConsoleApi2.h 透過 WinCon.h (,包括 Windows.h) |
程式庫 | Kernel32.lib |
DLL | Kernel32.dll |
Unicode 與 ANSI 名稱 | WriteConsoleOutputCharacterW (Unicode) 和 WriteConsoleOutputCharacterA (ANSI) |