Fungsi GetNumberOfConsoleInputEvents

Artikel
10/23/2023

Mengambil jumlah rekaman input yang belum dibaca di buffer input konsol.

Sintaks

BOOL WINAPI GetNumberOfConsoleInputEvents(
  _In_  HANDLE  hConsoleInput,
  _Out_ LPDWORD lpcNumberOfEvents
);

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.

lpcNumberOfEvents [out]
Penunjuk ke variabel yang menerima jumlah rekaman input yang belum dibaca di buffer input 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

Fungsi GetNumberOfConsoleInputEvents melaporkan jumlah total rekaman input yang belum dibaca di buffer input, termasuk keyboard, mouse, dan rekaman input pengubahan ukuran jendela. Proses menggunakan fungsi ReadFile atau ReadConsole hanya dapat membaca input keyboard. Proses menggunakan fungsi ReadConsoleInput dapat membaca semua jenis rekaman input.

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 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.

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

Bagikan melalui