Funzione GetNumberOfConsoleInputEvents

Articolo
07/12/2023

Recupera il numero di record di input non letti nel buffer di input della console.

Sintassi

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

Parametri

hConsoleInput [in]
Handle per il buffer di input della console. L'handle deve avere il diritto di accesso GENERIC_READ . Per altre informazioni, vedere Sicurezza dei buffer della console e diritti di accesso.

lpcNumberOfEvents [out]
Puntatore a una variabile che riceve il numero di record di input non letti nel buffer di input della console.

Valore restituito

Se la funzione ha esito positivo, il valore restituito è diverso da zero.

Se la funzione ha esito negativo, il valore restituito è zero. Per informazioni dettagliate sull'errore, chiamare GetLastError.

Osservazioni:

La funzione GetNumberOfConsoleInputEvents segnala il numero totale di record di input non letti nel buffer di input, tra cui tastiera, mouse e record di input di ridimensionamento delle finestre. I processi che usano la funzione ReadFile o ReadConsole possono leggere solo l'input da tastiera. I processi che usano la funzione ReadConsoleInput possono leggere tutti i tipi di record di input.

Un processo può specificare un handle del buffer di input della console in una delle funzioni di attesa per determinare quando è presente un input della console non letto. Quando il buffer di input non è vuoto, viene segnalato lo stato di un handle del buffer di input della console.

Per leggere i record di input da un buffer di input della console senza influire sul numero di record non letti, usare la funzione PeekConsoleInput. Per eliminare tutti i record non letti nel buffer di input di una console, usare la funzione FlushConsoleInputBuffer.

Requisiti


Client minimo supportato	Windows 2000 Professional [solo app desktop]
Server minimo supportato	Windows 2000 Server [solo app desktop]
Intestazione	ConsoleApi.h (tramite WinCon.h, con Windows.h)
Libreria	Kernel32.lib
DLL	Kernel32.dll