Fungsi WriteConsoleOutputAttribute

Artikel
12/13/2023

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.

Menyalin sejumlah atribut karakter ke sel berturut-turut dari buffer layar konsol, dimulai pada lokasi tertentu.

Sintaks

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

Parameter

hConsoleOutput [in]
Handel ke buffer layar konsol. Handel harus memiliki akses GENERIC_WRITE yang tepat. Untuk informasi selengkapnya, lihat Keamanan dan Hak Akses Buffer Konsol.

lpAttribute [in]
Atribut yang akan digunakan saat menulis ke buffer layar konsol. Untuk informasi selengkapnya, lihat Atribut Karakter.

nLength [in]
Jumlah sel karakter buffer layar tempat atribut akan disalin.

dwWriteCoord [in]
Struktur COORD yang menentukan koordinat karakter sel pertama di buffer layar konsol tempat atribut akan ditulis.

lpNumberOfAttrsWritten [out]
Pointer ke variabel yang menerima jumlah atribut yang benar-benar ditulis ke buffer layar konsol.

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

Jika jumlah atribut yang akan ditulis untuk meluas di luar akhir baris yang ditentukan di buffer layar konsol, atribut ditulis ke baris berikutnya. Jika jumlah atribut yang akan ditulis untuk meluas di luar akhir buffer layar konsol, atribut ditulis hingga akhir buffer layar konsol.

Nilai karakter pada posisi yang ditulis tidak diubah.

Tip

API ini memiliki terminal virtual yang setara dalam urutan pemformatan teks dan pemosisian kursor. Pindahkan kursor ke lokasi untuk menyisipkan, menerapkan pemformatan yang diinginkan, dan menulis teks untuk diisi. Tidak ada yang setara untuk menerapkan warna ke area tanpa juga memancarkan teks. Keputusan ini sengaja menyelaraskan platform Windows dengan sistem operasi lain di mana aplikasi klien individu diharapkan untuk mengingat status yang ditarik sendiri untuk manipulasi lebih lanjut.

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

Bagikan melalui