PeekConsoleInputW

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

PeekConsoleInputW hConsoleInput, lpBuffer, nLength, lpNumberOfEventsRead

hConsoleInput : [intptr] コンソール入力バッファのハンドル。ハンドルは **GENERIC\_READ** アクセス権を持っていなければならない。詳細は [コンソールバッファのセキュリティとアクセス権](console-buffer-security-and-access-rights.md) を参照。
lpBuffer : [var] 入力バッファのデータを受け取る [**INPUT\_RECORD**](input-record-str.md) 構造体の配列へのポインタ。
nLength : [int] *lpBuffer* 引数が指す配列のサイズ(配列要素数)。
lpNumberOfEventsRead : [var] 読み込まれた入力レコード数を受け取る変数へのポインタ。

(プラグイン / モジュール : kernel32.dll)

解説

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

[戻り値]
関数が成功した場合、戻り値は 0 以外である。関数が失敗した場合、戻り値は 0 である。拡張エラー情報を取得するには
[**GetLastError**](/windows/win32/api/errhandlingapi/nf-errhandlingapi-getlasterror)
を呼ぶ。

[備考]

要求されたレコード数がバッファ内の利用可能なレコード数を超える場合、利用可能な数が読み込まれる。データが利用できない場合、関数は直ちに戻る。[!INCLUDE
[setting-codepage-mode-remarks](./includes/setting-codepage-mode-remarks.md)]

情報

プラグイン / モジュールkernel32.dll
バージョン1.0
作成日2026/04/16
著作者IronHSP / CsWin32 bridge
URLhttps://github.com/inovia/IronHSP
備考Win32 API の kernel32.dll 関数群。CsWin32 + win32metadata から自動生成。
hsp3net 専用 (intptr / NSTRUCT / wstr を使用)。
タイプ拡張命令
グループWin32API
対応環境
  • Windows 版 HSP
hs ファイルhsphelp\win32_kernel32_gen2.hs