<Return[PQ]><Top>

PeekConsoleInput

Declare Function Api_PeekConsoleInput& Lib "kernel32" Alias "PeekConsoleInputA" (ByVal hConsoleInput&, ByVal lpBuffer&, ByVal nLength&, lpNumberOfEventsRead&)

Declare Function PeekConsoleInput Lib "kernel32" Alias "PeekConsoleInputA" (ByVal hConsoleInput As Long, ByVal lpBuffer As Long, ByVal nLength As Long, lpNumberOfEventsRead As Long) As Long

指定したコンソール入力バッファからデータを読み取る。読み取ったデータはバッファから削除しない。

パラメータ
hConsoleInput
    入力バッファのハンドルを指定する。このハンドルには、GENERIC_READ アクセス権が必要である。

lpBuffer
    読み取ったデータを受け取る INPUT_RECORD バッファへのポインタを指定する。
nLength

    lpBuffer が指すバッファのサイズをレコード数で指定する。
lpNumberOfEventsRead
    読み取った入力レコード数を受け取る 32 ビット変数へのポインタを指定する。

戻り値
    関数が成功すると、0 以外の値が返る。
    関数が失敗すると、0 が返る。拡張エラー情報を取得するには、GetLastError 関数を使う。

解説
    要求したレコード数がバッファ内にあるレコードの数より多い場合は、バッファ内にあるレコードだけが読み取られる。データがない場合は、関

    数がただちに制御を戻す。
    Windows NT/2000:この関数は、コンソールの現在のコードページにある Unicode 文字または 8 ビット文字のいずれかを使う。コンソール

    のコードページは、既定値でシステムの OEM コードページに初期設定される。コンソールのコードページを変更するには、SetConsoleCP 関

    数、SetConsoleOutputCP 関数、chcp コマンド、mode con cp select= コマンドのいずれかを使う。