Função GetNumberOfConsoleInputEvents
Recupera o número de registros de entrada não lidos no buffer de entrada do console.
Sintaxe
BOOL WINAPI GetNumberOfConsoleInputEvents(
_In_ HANDLE hConsoleInput,
_Out_ LPDWORD lpcNumberOfEvents
);
Parâmetros
hConsoleInput [in]
Um identificador do buffer da entrada do console. O identificador deve ter o direito de acesso GENERIC_READ. Para saber mais, confira Segurança de buffer e direitos de acesso do console.
lpcNumberOfEvents [out]
Um ponteiro para uma variável que recebe o número de registros de entrada não lidos no buffer de entrada do console.
Valor retornado
Se a função for bem-sucedida, o valor retornado será diferente de zero.
Se a função falhar, o valor retornado será zero. Para obter informações de erro estendidas, chame GetLastError.
Comentários
A função GetNumberOfConsoleInputEvents faz o relatório do número total de registros de entrada não lidos no buffer de entrada, incluindo registros de entrada de teclado, mouse e redimensionamento de janela. Os processos que usam a função ReadFile ou ReadConsole somente podem ler a entrada do teclado. Os processos que usam a função ReadConsoleInput podem ler todos os tipos de registros de entrada.
Um processo pode especificar um identificador de buffer de entrada do console em uma das funções de espera para determinar quando há entrada de console não lida. Quando o buffer de entrada não está vazio, o estado de um identificador de buffer de entrada do console é sinalizado.
Para ler registros de entrada de um buffer de entrada do console sem afetar o número de registros não lidos, use a função PeekConsoleInput. Para descartar todos os registros não lidos no buffer de entrada do console, use a função FlushConsoleInputBuffer.
Requisitos
| Cliente mínimo com suporte | Windows 2000 Professional [somente aplicativos da área de trabalho] |
| Servidor mínimo com suporte | Windows 2000 Server [somente aplicativos da área de trabalho] |
| Cabeçalho | ConsoleApi.h (via WinCon.h, inclui o Windows.h) |
| Biblioteca | Kernel32.lib |
| DLL | Kernel32.dll |