PeekConsoleInput 関数

指定したコンソール入力バッファーからデータをバッファーから削除せずに読み取ります。

構文

BOOL WINAPI PeekConsoleInput(
  _In_  HANDLE        hConsoleInput,
  _Out_ PINPUT_RECORD lpBuffer,
  _In_  DWORD         nLength,
  _Out_ LPDWORD       lpNumberOfEventsRead
);

パラメーター

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

lpBuffer [out]
入力バッファー データを受信する INPUT_RECORD 構造体の配列へのポインター。

nLength [in]
lpBuffer パラメーターが指す配列のサイズ (配列要素)。

lpNumberOfEventsRead [out]
読み込まれた入力レコードの数を受け取る変数へのポインター。

戻り値

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

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

解説

要求されたレコードの数がバッファー内で使用可能なレコードの数を超える場合は、使用可能な数が読み取られます。 使用できるデータがない場合、関数はすぐに返されます。

この関数では、Unicode 文字またはコンソールの現在のコード ページの 8 ビット文字が使用されます。 コンソールのコード ページには、最初はシステムの OEM コード ページが既定で設定されます。 コンソールのコード ページを変更するには、SetConsoleCP または SetConsoleOutputCP 関数を使用します。 従来のユーザーは、chcp または mode con cp select= コマンドを使用することもできますが、それは新規の開発ではお勧めできません。

要件

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

関連項目

コンソール関数

ReadConsoleInput

SetConsoleCP

SetConsoleOutputCP

WriteConsoleInput

INPUT_RECORD