WriteConsoleOutputAttribute 函式

發行項
12/13/2023

重要

本文件說明已不再是生態系統藍圖一部分的控制台平臺功能。我們不建議您在新產品中使用此內容，但我們將繼續支持無限期的未來現有使用量。我們慣用的新式解決方案著重於 虛擬終端機序列 ，以在跨平臺案例中達到最大相容性。您可以在傳統 主控台與虛擬終端機 檔中找到此設計決策的詳細資訊。

從指定位置開始，將一些字元屬性複製到主控台畫面緩衝區的連續儲存格。

語法

BOOL WINAPI WriteConsoleOutputAttribute(
  _In_        HANDLE  hConsoleOutput,
  _In_  const WORD    *lpAttribute,
  _In_        DWORD   nLength,
  _In_        COORD   dwWriteCoord,
  _Out_       LPDWORD lpNumberOfAttrsWritten
);

參數

hConsoleOutput [in]
主控台螢幕緩衝區的控點。句柄必須具有 GENERIC_WRITE 訪問許可權。如需詳細資訊，請參閱主控台緩衝區安全性和存取權限。

lpAttribute [in]
寫入主控台畫面緩衝區時要使用的屬性。如需詳細資訊，請參閱字元屬性。

nLength [in]
將複製屬性的螢幕緩衝區字元儲存格數目。

dwWriteCoord [in]
COORD 結構，指定將寫入屬性之控制台畫面緩衝區中第一個儲存格的字元座標。

lpNumberOfAttrsWritten [out]
變數的指標，可接收實際寫入控制台畫面緩衝區的屬性數目。

傳回值

如果函式成功，則傳回非零的值。

如果此函式失敗，則傳回值為零。若要取得擴充的錯誤資訊，請呼叫 GetLastError。

備註

如果要寫入以延伸至控制台畫面緩衝區中指定數據列結尾的屬性數目，則會將屬性寫入下一個數據列。如果要寫入以延伸至超出控制台畫面緩衝區結尾的屬性數目，屬性會寫入控制台畫面緩衝區的結尾。

寫入位置的字元值不會變更。

提示

此 API 具有文字格式設定和 游標定位序列中的虛擬終端機對等專案。將游標移至要插入的位置、套用所需的格式設定，以及寫出要填滿的文字。沒有相當於將色彩套用至區域而不發出文字。此決策會刻意讓 Windows 平臺與其他作業系統保持一致，其中個別用戶端應用程式預期會記住自己的繪製狀態，以便進一步操作。

需求


最低支援的用戶端	Windows 2000 Professional [僅限傳統型應用程式]
最低支援的伺服器	Windows 2000 Server [僅限傳統型應用程式]
頁首	ConsoleApi2.h （透過 WinCon.h，包含 Windows.h）
程式庫	Kernel32.lib
DLL	Kernel32.dll