Fungsi SetConsoleTextAttribute
Penting
Dokumen ini menjelaskan fungsionalitas platform konsol yang tidak lagi menjadi bagian dari peta jalan ekosistem kami. Kami tidak menyarankan penggunaan konten ini dalam produk baru, tetapi kami akan terus mendukung penggunaan yang ada untuk masa depan yang tidak terbatas. Solusi modern pilihan kami berfokus pada urutan terminal virtual untuk kompatibilitas maksimum dalam skenario lintas platform. Anda dapat menemukan informasi selengkapnya tentang keputusan desain ini di konsol klasik vs. dokumen terminal virtual kami.
Mengatur atribut karakter yang ditulis ke buffer layar konsol oleh fungsi WriteFile atau WriteConsole, atau digaungkan oleh fungsi ReadFile atau ReadConsole. Fungsi ini memengaruhi teks yang ditulis setelah panggilan fungsi.
Sintaks
BOOL WINAPI SetConsoleTextAttribute(
_In_ HANDLE hConsoleOutput,
_In_ WORD wAttributes
);
Parameter
hConsoleOutput [in]
Handel ke buffer layar konsol. Handel harus memiliki akses GENERIC_READ yang tepat. Untuk informasi selengkapnya, lihat Keamanan dan Hak Akses Buffer Konsol.
wAttributes [in]
Atribut karakter.
Nilai hasil
Jika fungsi berhasil, nilai yang dikembalikan bukan nol.
Jika fungsi gagal, nilai yang dikembalikan adalah nol. Untuk mendapatkan informasi kesalahan yang diperluas, hubungi GetLastError.
Keterangan
Untuk menentukan atribut warna buffer layar saat ini, panggil fungsi GetConsoleScreenBufferInfo.
Tip
API ini memiliki terminal virtual yang setara dalam urutan pemformatan teks. Urutan terminal virtual direkomendasikan untuk semua pengembangan baru dan yang sedang berlangsung.
Contoh
Misalnya, lihat Menggunakan Fungsi Input dan Output Tingkat Tinggi.
Persyaratan
| Klien minimum yang didukung | Windows 2000 Professional [hanya aplikasi desktop] |
| Server minimum yang didukung | Windows 2000 Server [hanya aplikasi desktop] |
| Header | ConsoleApi2.h (melalui WinCon.h, termasuk Windows.h) |
| Pustaka | Kernel32.lib |
| DLL | Kernel32.dll |