FillConsoleOutputAttribute 函式

發行項
12/13/2023

重要

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

設定指定字元儲存格數目的字元屬性，從螢幕緩衝區中的指定座標開始。

語法

BOOL WINAPI FillConsoleOutputAttribute(
  _In_  HANDLE  hConsoleOutput,
  _In_  WORD    wAttribute,
  _In_  DWORD   nLength,
  _In_  COORD   dwWriteCoord,
  _Out_ LPDWORD lpNumberOfAttrsWritten
);

參數

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

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

nLength [in]
要設定為指定色彩屬性的字元儲存格數目。

dwWriteCoord [in]
COORD 結構，指定要設定其屬性的第一個儲存格的字元座標。

lpNumberOfAttrsWritten [out]
變數的指標，可接收實際設定其屬性的字元單元格數目。

傳回值

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

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

備註

如果要設定其屬性的字元儲存格數目超出控制台畫面緩衝區中指定數據列的結尾，則會設定下一個數據列的儲存格。如果要寫入的單元格數目延伸超過控制台畫面緩衝區結尾，則單元格會寫入控制台畫面緩衝區的結尾。

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

提示

不建議使用此 API，而且沒有特定的 虛擬終端 機對等專案。不支援在可檢視視窗外填滿區域，並保留給終端機的歷程記錄空間。使用新文字或色彩填滿可見區域時，會透過移動游標、設定新屬性，然後為該區域寫入所需的文字，並視需要為填滿執行長度重複字元。可能需要額外的游標移動，然後撰寫所需的文字以填滿矩形區域。用戶端應用程式應該會保留自己在螢幕上的記憶體，而且無法查詢遠端狀態。如需詳細資訊，請參閱 傳統控制台與虛擬終端機 檔。

需求


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