Fungsi ReadConsoleInput

Artikel
10/23/2023

Membaca data dari buffer input konsol dan menghapusnya dari buffer.

Sintaks

BOOL WINAPI ReadConsoleInput(
  _In_  HANDLE        hConsoleInput,
  _Out_ PINPUT_RECORD lpBuffer,
  _In_  DWORD         nLength,
  _Out_ LPDWORD       lpNumberOfEventsRead
);

Parameter

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

lpBuffer [keluar]
Penunjuk ke array struktur INPUT_RECORD yang menerima data buffer input.

nLength [in]
Ukuran array yang diacu oleh parameter lpBuffer , dalam elemen array.

lpNumberOfEventsRead [out]
Penunjuk ke variabel yang menerima jumlah rekaman input yang 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 rekaman yang diminta dalam parameter nLength melebihi jumlah rekaman yang tersedia di buffer, jumlah yang tersedia akan dibaca. Fungsi tidak mengembalikan hingga setidaknya satu rekaman input telah dibaca.

Proses dapat menentukan handel buffer input konsol di salah satu fungsi tunggu untuk menentukan kapan ada input konsol yang belum dibaca. Ketika buffer input tidak kosong, status handel buffer input konsol akan disinyalir.

Untuk menentukan jumlah rekaman input yang belum dibaca di buffer input konsol, gunakan fungsi GetNumberOfConsoleInputEvents. Untuk membaca rekaman input dari buffer input konsol tanpa memengaruhi jumlah rekaman yang belum dibaca, gunakan fungsi PeekConsoleInput. Untuk membuang semua rekaman yang belum dibaca di buffer input konsol, gunakan fungsi FlushConsoleInputBuffer.

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.

Contoh

Misalnya, lihat Membaca Peristiwa Buffer Input.

Persyaratan


Klien minimum yang didukung	Windows 2000 Professional [hanya aplikasi desktop]
Server minimum yang didukung	Windows 2000 Server [hanya aplikasi desktop]
Header	ConsoleApi.h (melalui WinCon.h, sertakan Windows.h)
Pustaka	Kernel32.lib
DLL	Kernel32.dll
Nama Unicode dan ANSI	ReadConsoleInputW (Unicode) dan ReadConsoleInputA (ANSI)

Share via