Fungsi FillConsoleOutputCharacter

Artikel
07/12/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.

Menulis karakter ke buffer layar konsol beberapa kali, dimulai pada koordinat yang ditentukan.

Sintaks

BOOL WINAPI FillConsoleOutputCharacter(
  _In_  HANDLE  hConsoleOutput,
  _In_  TCHAR   cCharacter,
  _In_  DWORD   nLength,
  _In_  COORD   dwWriteCoord,
  _Out_ LPDWORD lpNumberOfCharsWritten
);

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.

cCharacter [in]
Karakter yang akan ditulis ke buffer layar konsol.

nLength [in]
Jumlah sel karakter tempat karakter harus ditulis.

dwWriteCoord [in]
Struktur COORD yang menentukan koordinat karakter sel pertama tempat karakter akan ditulis.

lpNumberOfCharsWritten [out]
Pointer ke variabel yang menerima jumlah karakter 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 karakter yang akan ditulis untuk diperluas di luar akhir baris yang ditentukan di buffer layar konsol, karakter ditulis ke baris berikutnya. Jika jumlah karakter yang akan ditulis meluas di luar akhir buffer layar konsol, karakter ditulis hingga akhir buffer layar konsol.

Nilai atribut pada posisi yang ditulis tidak diubah.

Fungsi ini menggunakan karakter Unicode atau karakter 8-bit dari halaman kode konsol saat ini. Halaman kode konsol default awalnya ke halaman kode OEM sistem. Untuk mengubah halaman kode konsol, gunakan fungsi SetConsoleCP atau SetConsoleOutputCP. Konsumen warisan juga dapat menggunakan perintah chcp atau mode con cp select= , tetapi tidak disarankan untuk pengembangan baru.

Tip

API ini tidak disarankan dan tidak memiliki terminal virtual tertentu yang setara. Mengisi wilayah di luar jendela yang dapat dilihat tidak didukung dan dicadangkan untuk ruang riwayat terminal. Mengisi wilayah yang terlihat dengan teks atau warna baru dilakukan melalui pemindahan kursor, mengatur atribut baru, lalu menulis teks yang diinginkan untuk wilayah tersebut, mengulangi karakter jika perlu untuk panjang eksekusi isian. Gerakan kursor tambahan mungkin diperlukan diikuti dengan menulis teks yang diinginkan untuk mengisi wilayah persegi panjang. Aplikasi klien diharapkan untuk menyimpan memorinya sendiri tentang apa yang ada di layar dan tidak dapat mengkueri status jarak jauh. Informasi lebih lanjut dapat ditemukan di konsol klasik versus dokumentasi terminal virtual.

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
Nama Unicode dan ANSI	FillConsoleOutputCharacterW (Unicode) dan FillConsoleOutputCharacterA (ANSI)

Bagikan melalui