Fungsi WriteConsoleOutputCharacter
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 karakter ke sel berturut-turut dari buffer layar konsol, dimulai pada lokasi tertentu.
Sintaks
BOOL WINAPI WriteConsoleOutputCharacter(
_In_ HANDLE hConsoleOutput,
_In_ LPCTSTR lpCharacter,
_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.
lpCharacter [in]
Karakter yang akan ditulis ke buffer layar konsol.
nLength [in]
Jumlah karakter yang akan ditulis.
dwWriteCoord [in]
Struktur COORD yang menentukan koordinat karakter sel pertama di buffer layar konsol tempat karakter akan ditulis.
lpNumberOfCharsWritten [out]
Pointer ke variabel yang menerima jumlah karakter yang benar-benar ditulis.
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 meluas di luar akhir baris yang ditentukan di buffer layar konsol, karakter ditulis ke baris berikutnya. Jika jumlah karakter yang akan ditulis untuk 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 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 memancarkan teks ke area tanpa juga menerapkan pemformatan warna aktif. 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 |
| Nama Unicode dan ANSI | WriteConsoleOutputCharacterW (Unicode) dan WriteConsoleOutputCharacterA (ANSI) |