SetConsoleTextAttribute 函式

重要

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

設定 由 WriteFileWriteConsole 函式寫入主控台畫面緩衝區的字元屬性,或 由 ReadFileReadConsole 函式回應。 此函式會影響函式呼叫之後所撰寫的文字。

語法

BOOL WINAPI SetConsoleTextAttribute(
  _In_ HANDLE hConsoleOutput,
  _In_ WORD   wAttributes
);

參數

hConsoleOutput [in]
主控台螢幕緩衝區的控點。 控制碼必須具有 GENERIC_READ 存取權限。 如需詳細資訊,請參閱主控台緩衝區安全性和存取權限

wAttributes [in]
字元屬性

傳回值

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

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

備註

若要判斷螢幕緩衝區的目前色彩屬性,請呼叫 GetConsoleScreenBufferInfo 函式。

提示

此 API 在文字格式設定序列中具有對等的虛擬終端機。 建議針對所有新的和持續開發使用虛擬終端機序列

範例

如需範例,請參閱 使用High-Level輸入和輸出函式

規格需求

   
最低支援的用戶端 Windows 2000 專業版 [僅限傳統型應用程式]
最低支援的伺服器 Windows 2000 Server [僅限傳統型應用程式]
標頭 ConsoleApi2.h 透過 WinCon.h (,包括 Windows.h)
程式庫 Kernel32.lib
DLL Kernel32.dll

另請參閱

主控台函式

主控台畫面緩衝區

GetConsoleScreenBufferInfo

ReadConsole

ReadFile

WriteConsole

WriteFile