Функция GetNumberOfConsoleInputEvents

Статья
07/12/2023

Извлекает количество непрочитанных входных записей в входном буфере консоли.

Синтаксис

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

Параметры

hConsoleInput [in]
Дескриптор входного буфера консоли. Этот дескриптор должен иметь право доступа GENERIC_READ. Дополнительные сведения см. в статье Безопасность и права доступа для буфера консоли.

lpcNumberOfEvents [out]
Указатель на переменную, которая получает количество непрочитанных входных записей в входном буфере консоли.

Возвращаемое значение

Если функция выполняется успешно, возвращается ненулевое значение.

Если функция выполняется неудачно, возвращается нулевое значение. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.

Замечания

Функция GetNumberOfConsoleInputEvents сообщает общее количество непрочитанных входных записей во входном буфере, включая клавиатуру, мышь и входные записи с изменением размера окна. Процессы, использующие функцию ReadFile или ReadConsole, могут читать только входные данные клавиатуры. Процессы, использующие функцию ReadConsoleInput , могут считывать все типы входных записей.

Процесс может указать дескриптор входного буфера консоли в одной из функций ожидания, чтобы определить, когда есть непрочитанные входные данные консоли. Если входной буфер не пуст, состояние дескриптора входного буфера консоли сигнализируется.

Чтобы считывать входные записи из буфера ввода консоли, не влияя на количество непрочитанных записей, используйте функцию PeekConsoleInput . Чтобы отменить карта все непрочитанные записи во входном буфере консоли, используйте функцию FlushConsoleInputBuffer.

Requirements


Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Верхний колонтитул	ConsoleApi.h (через WinCon.h, включая Windows.h)
Библиотека	Kernel32.lib
DLL-библиотеки	Kernel32.dll