GetNumberOfConsoleInputEvents Funktion
Ruft die Anzahl der ungelesenen Eingabedatensätze im Eingabepuffer der Konsole ab.
Syntax
BOOL WINAPI GetNumberOfConsoleInputEvents(
_In_ HANDLE hConsoleInput,
_Out_ LPDWORD lpcNumberOfEvents
);
Parameter
hConsoleInput [in]
Ein Handle für den Konsolenbildschirm-Puffer. Das Handle muss über das Zugriffsrecht GENERIC_READ verfügen. Weitere Informationen finden Sie unter Sicherheit und Zugriffsrechte für Konsolenpuffer.
lpcNumberOfEvents [out]
Ein Zeiger auf eine Variable, die die Anzahl der ungelesenen Eingabedatensätze im Eingabepuffer der Konsole empfängt.
Rückgabewert
Wenn die Funktion erfolgreich ist, ist der Rückgabewert ungleich Null.
Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.
Hinweise
Die GetNumberOfConsoleInputEvents-Funktion meldet die Gesamtanzahl der ungelesenen Eingabedatensätze im Eingabepuffer, einschließlich Tastatur- und Maus- und Fensteränderungseingabedatensätze. Prozesse, die die ReadFile- oder ReadConsole-Funktion verwenden, können nur Tastatureingaben lesen. Prozesse mit der ReadConsoleInput-Funktion können alle Arten von Eingabedatensätzen lesen.
Ein Prozess kann ein Konsoleneingabepufferhandle in einer der Wartefunktionen angeben, um zu bestimmen, wann ungelesene Konsoleneingaben vorhanden sind. Wenn der Eingabepuffer nicht leer ist, wird der Zustand eines Konsoleneingabepufferhandles signalisiert.
Verwenden Sie die PeekConsoleInput-Funktion , um Eingabedatensätze aus einem Konsoleneingabepuffer ohne Auswirkungen auf die Anzahl ungelesener Datensätze zu lesen. Um alle ungelesenen Datensätze im Eingabepuffer einer Konsole auszuschließen, verwenden Sie die FlushConsoleInputBuffer-Funktion.
Anforderungen
Unterstützte Mindestversion (Client) | Windows 2000 Professional [nur Desktop-Apps] |
Unterstützte Mindestversion (Server) | Windows 2000 Server [nur Desktop-Apps] |
Header | ConsoleApi.h (über WinCon.h, Windows.h einschließen) |
Bibliothek | Kernel32.lib |
DLL | Kernel32.dll |