Fungsi ReadConsoleOutputCharacter
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 dari sel berturut-turut dari buffer layar konsol, dimulai pada lokasi tertentu.
Sintaks
BOOL WINAPI ReadConsoleOutputCharacter(
_In_ HANDLE hConsoleOutput,
_Out_ LPTSTR lpCharacter,
_In_ DWORD nLength,
_In_ COORD dwReadCoord,
_Out_ LPDWORD lpNumberOfCharsRead
);
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.
lpCharacter [out]
Penunjuk ke buffer yang menerima karakter yang dibaca dari buffer layar konsol.
nLength [in]
Jumlah sel karakter buffer layar yang akan dibaca. Ukuran buffer yang diacu oleh parameter lpCharacter harus nLength * sizeof(TCHAR).
dwReadCoord [in]
Koordinat sel pertama di buffer layar konsol tempat membaca karakter. Anggota X dari struktur COORD adalah kolom , dan anggota Y adalah baris .
lpNumberOfCharsRead [out]
Pointer ke variabel yang menerima jumlah karakter yang benar-benar dibaca.
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 dibaca dari memperluas di luar akhir baris buffer layar yang ditentukan, karakter akan dibaca dari baris berikutnya. Jika jumlah karakter yang akan dibaca dari memperluas di luar akhir buffer layar konsol, karakter hingga akhir buffer layar konsol akan dibaca.
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 yang setara. 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. Aplikasi jarak jauh melalui utilitas lintas platform dan transportasi seperti SSH mungkin tidak berfungsi seperti yang diharapkan jika menggunakan API ini.
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 | ReadConsoleOutputCharacterW (Unicode) dan ReadConsoleOutputCharacterA (ANSI) |