Fonction GetNumberOfConsoleInputEvents

Article
12/22/2023

Récupère le nombre d’enregistrements d’entrée non lus dans la mémoire tampon d’entrée de la console.

Syntaxe

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

Paramètres

hConsoleInput [entrée]
Un descripteur vers la mémoire tampon d’entrée de console. Le descripteur doit avoir le droit d’accès GENERIC_READ. Pour plus d’informations, consultez Sécurité de la mémoire tampon et droits d’accès d’une console.

lpcNumberOfEvents [sortie]
Un pointeur vers une variable qui reçoit le nombre d'enregistrements d'entrée non lus dans la mémoire tampon d'entrée de console.

Valeur renvoyée

Si la fonction réussit, la valeur de retour est différente de zéro.

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Notes

La fonction GetNumberOfConsoleInputEvents signale le nombre total d’enregistrements d’entrée non lus dans la mémoire tampon d’entrée, notamment les enregistrements d’entrée de clavier, de souris et de fenêtre. Les processus utilisant la fonction ReadFile ou ReadConsole peuvent uniquement lire l’entrée de clavier. Les processus utilisant la fonction ReadConsoleInput peuvent lire tous les types d’enregistrements d’entrée.

Un processus peut spécifier un descripteur de mémoire tampon d’entrée de console dans l’une des fonctions d’attente pour déterminer s’il existe une entrée de console non lus. Lorsque la mémoire tampon d’entrée n’est pas vide, l’état d’un descripteur de mémoire tampon d’entrée de console est signalé.

Pour lire les enregistrements d’entrée à partir d’une mémoire tampon d’entrée de console sans affecter le nombre d’enregistrements non lus, utilisez la fonction PeekConsoleInput. Pour ignorer tous les enregistrements non lus dans la mémoire tampon d’entrée d'une console, utilisez la fonction FlushConsoleInputBuffer.

Spécifications


Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
En-tête	ConsoleApi.h (via WinCon.h, inclure Windows.h)
Bibliothèque	Kernel32.lib
DLL	Kernel32.dll