Función GetNumberOfConsoleInputEvents

Artículo
12/21/2023

Recupera el número de registros de entrada no leídos en el búfer de entrada de la consola.

Sintaxis

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

Parámetros

hConsoleInput [in]
Identificador del búfer de entrada de la consola. El identificador debe tener derecho de acceso de GENERIC_READ. Para obtener más información, consulte Seguridad y derechos de acceso del búfer de la consola.

lpcNumberOfEvents [out]
Puntero a una variable que recibe el número de registros de entrada no leídos en el búfer de entrada de la consola.

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es distinto de cero.

Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Comentarios

La función GetNumberOfConsoleInputEvents informa del número total de registros de entrada no leídos en el búfer de entrada, incluidos los registros de entrada de teclado, mouse y cambio de tamaño de ventana. Los procesos en los que se utilizan las funciones ReadFile o ReadConsole solo pueden leer la entrada de teclado. Aquellos en los que se utiliza la función ReadConsoleInput pueden leer todos los tipos de registros de entrada.

Un proceso puede especificar un identificador de búfer de entrada de la consola en una de las funciones de espera (wait) para determinar cuándo hay entradas de consola no leídas. Cuando el búfer de entrada no está vacío, se señala el estado de un identificador de búfer de entrada de la consola.

Para leer registros de entrada desde un búfer de entrada de la consola sin que afecte al número de registros no leídos, utilice la función PeekConsoleInput. Para descartar todos los registros no leídos en el búfer de entrada de una consola, utilice la función FlushConsoleInputBuffer.

Requisitos


Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Encabezado	ConsoleApi.h (a través de WinCon.h, incluido Windows.h)
Biblioteca	Kernel32.lib
Archivo DLL	Kernel32.dll