次の方法で共有


GetNumberOfConsoleInputEvents 関数

コンソールの入力バッファー内の未読入力レコードの数を取得します。

構文

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

パラメーター

hConsoleInput [in]
コンソール入力バッファへのハンドル。 ハンドルには、GENERIC_READ アクセス権があります。 詳細については、「コンソール バッファーのセキュリティとアクセス権」を参照してください。

lpcNumberOfEvents [out]
コンソールの入力バッファー内の未読入力レコードの数を受信する変数へのポインター。

戻り値

関数が成功すると、戻り値は 0 以外になります。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

GetNumberOfConsoleInputEvents 関数は、キーボード、マウス、ウィンドウサイズ変更の入力レコードを含む、入力バッファー内の未読入力レコードの合計数を報告します。 ReadFile または ReadConsole 関数を使用するプロセスでは、キーボード入力のみを読み取ることができます。 ReadConsoleInput 関数を使用するプロセスは、すべての種類の入力レコードを読み取ることができます。

プロセスは、待機関数の 1 つでコンソール入力バッファー ハンドルを指定して、コンソール入力が未読かどうかを判断できます。 入力バッファーが空でない場合は、コンソール入力バッファー ハンドルの状態が通知されます。

未読レコードの数に影響を与えずにコンソール入力バッファーから入力レコードを読み取る場合は、PeekConsoleInput 関数を使用します。 コンソールの入力バッファー内のすべての未読レコードを破棄するには、FlushConsoleInputBuffer 関数を使用します。

要件

   
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
ヘッダー ConsoleApi.h (WinCon.h 経由、Windows.h をインクルード)
ライブラリ Kernel32.lib
[DLL] Kernel32.dll

関連項目

コンソール関数

FlushConsoleInputBuffer

低レベル コンソール入力関数

PeekConsoleInput

ReadConsole

ReadConsoleInput

ReadFile