Функция GetNumberOfConsoleInputEvents

Функция GetNumberOfConsoleInputEvents извлекает число непрочитанных записей введенных данных в буфере ввода консоли.

Синтаксис

BOOL GetNumberOfConsoleInputEvents(

HANDLE hConsoleInput, // дескриптор буфера ввода консоли
LPDWORD
lpcNumberOfEvents // число событий

);

Параметры

hConsoleInput

[in] Дескриптор консольного буфера ввода. Дескриптор должен иметь право доступа GENERIC_READ. Для получения дополнительной информации, см. статью Защита буфера и права доступа в консоли.

lpcNumberOfEvents

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

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

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

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

Замечания

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

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

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

Смотри также

Обзор консольных приложений, Функции консоли, FlushConsoleInputBuffer, PeekConsoleInput, ReadConsole, ReadConsoleInput, ReadFile

Размещение и совместимость GetNumberOfConsoleInputEvents

Windows. NET Server

Да

Windows XP

Да

Windows 2000

Да

Windows NT

Да

Windows Me

Да

Windows 98

Да

Windows 95

Да

Используемая библиотека

Kernel32.lib

Заголовочный файл

 

- объявлено в

Wincon.h

- включено в

Windows.h

Unicode

Нет

Замечания по платформе

Не имеется

 

Назад в оглавление
На главную страницу
На оглавление справки

Hosted by uCoz