ホーム › System.Console › PeekConsoleInputW
PeekConsoleInputW
関数コンソール入力バッファのイベントを削除せず先読みする(Unicode版)。
シグネチャ
// KERNEL32.dll (Unicode / -W)
#include <windows.h>
BOOL PeekConsoleInputW(
HANDLE hConsoleInput,
INPUT_RECORD* lpBuffer,
DWORD nLength,
DWORD* lpNumberOfEventsRead
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| hConsoleInput | HANDLE | in | コンソール入力バッファのハンドル。 |
| lpBuffer | INPUT_RECORD* | out | 読み取った入力レコードを受け取るINPUT_RECORD配列へのポインタ。読み取り後も入力は残る。 |
| nLength | DWORD | in | lpBufferが保持できるINPUT_RECORDの最大数。 |
| lpNumberOfEventsRead | DWORD* | out | 覗き見したイベント数を受け取る出力DWORDポインタ。 |
戻り値の型: BOOL
各言語での呼び出し定義
// KERNEL32.dll (Unicode / -W)
#include <windows.h>
BOOL PeekConsoleInputW(
HANDLE hConsoleInput,
INPUT_RECORD* lpBuffer,
DWORD nLength,
DWORD* lpNumberOfEventsRead
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool PeekConsoleInputW(
IntPtr hConsoleInput, // HANDLE
IntPtr lpBuffer, // INPUT_RECORD* out
uint nLength, // DWORD
out uint lpNumberOfEventsRead // DWORD* out
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function PeekConsoleInputW(
hConsoleInput As IntPtr, ' HANDLE
lpBuffer As IntPtr, ' INPUT_RECORD* out
nLength As UInteger, ' DWORD
<Out> ByRef lpNumberOfEventsRead As UInteger ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function' hConsoleInput : HANDLE
' lpBuffer : INPUT_RECORD* out
' nLength : DWORD
' lpNumberOfEventsRead : DWORD* out
Declare PtrSafe Function PeekConsoleInputW Lib "kernel32" ( _
ByVal hConsoleInput As LongPtr, _
ByVal lpBuffer As LongPtr, _
ByVal nLength As Long, _
ByRef lpNumberOfEventsRead As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
PeekConsoleInputW = ctypes.windll.kernel32.PeekConsoleInputW
PeekConsoleInputW.restype = wintypes.BOOL
PeekConsoleInputW.argtypes = [
wintypes.HANDLE, # hConsoleInput : HANDLE
ctypes.c_void_p, # lpBuffer : INPUT_RECORD* out
wintypes.DWORD, # nLength : DWORD
ctypes.POINTER(wintypes.DWORD), # lpNumberOfEventsRead : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
PeekConsoleInputW = Fiddle::Function.new(
lib['PeekConsoleInputW'],
[
Fiddle::TYPE_VOIDP, # hConsoleInput : HANDLE
Fiddle::TYPE_VOIDP, # lpBuffer : INPUT_RECORD* out
-Fiddle::TYPE_INT, # nLength : DWORD
Fiddle::TYPE_VOIDP, # lpNumberOfEventsRead : DWORD* out
],
Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "kernel32")]
extern "system" {
fn PeekConsoleInputW(
hConsoleInput: *mut core::ffi::c_void, // HANDLE
lpBuffer: *mut INPUT_RECORD, // INPUT_RECORD* out
nLength: u32, // DWORD
lpNumberOfEventsRead: *mut u32 // DWORD* out
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool PeekConsoleInputW(IntPtr hConsoleInput, IntPtr lpBuffer, uint nLength, out uint lpNumberOfEventsRead);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_PeekConsoleInputW' -Namespace Win32 -PassThru
# $api::PeekConsoleInputW(hConsoleInput, lpBuffer, nLength, lpNumberOfEventsRead)#uselib "KERNEL32.dll"
#func global PeekConsoleInputW "PeekConsoleInputW" wptr, wptr, wptr, wptr
; PeekConsoleInputW hConsoleInput, varptr(lpBuffer), nLength, varptr(lpNumberOfEventsRead) ; 戻り値は stat
; hConsoleInput : HANDLE -> "wptr"
; lpBuffer : INPUT_RECORD* out -> "wptr"
; nLength : DWORD -> "wptr"
; lpNumberOfEventsRead : DWORD* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "KERNEL32.dll" #cfunc global PeekConsoleInputW "PeekConsoleInputW" sptr, var, int, var ; res = PeekConsoleInputW(hConsoleInput, lpBuffer, nLength, lpNumberOfEventsRead) ; hConsoleInput : HANDLE -> "sptr" ; lpBuffer : INPUT_RECORD* out -> "var" ; nLength : DWORD -> "int" ; lpNumberOfEventsRead : DWORD* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll" #cfunc global PeekConsoleInputW "PeekConsoleInputW" sptr, sptr, int, sptr ; res = PeekConsoleInputW(hConsoleInput, varptr(lpBuffer), nLength, varptr(lpNumberOfEventsRead)) ; hConsoleInput : HANDLE -> "sptr" ; lpBuffer : INPUT_RECORD* out -> "sptr" ; nLength : DWORD -> "int" ; lpNumberOfEventsRead : DWORD* out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; BOOL PeekConsoleInputW(HANDLE hConsoleInput, INPUT_RECORD* lpBuffer, DWORD nLength, DWORD* lpNumberOfEventsRead) #uselib "KERNEL32.dll" #cfunc global PeekConsoleInputW "PeekConsoleInputW" intptr, var, int, var ; res = PeekConsoleInputW(hConsoleInput, lpBuffer, nLength, lpNumberOfEventsRead) ; hConsoleInput : HANDLE -> "intptr" ; lpBuffer : INPUT_RECORD* out -> "var" ; nLength : DWORD -> "int" ; lpNumberOfEventsRead : DWORD* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL PeekConsoleInputW(HANDLE hConsoleInput, INPUT_RECORD* lpBuffer, DWORD nLength, DWORD* lpNumberOfEventsRead) #uselib "KERNEL32.dll" #cfunc global PeekConsoleInputW "PeekConsoleInputW" intptr, intptr, int, intptr ; res = PeekConsoleInputW(hConsoleInput, varptr(lpBuffer), nLength, varptr(lpNumberOfEventsRead)) ; hConsoleInput : HANDLE -> "intptr" ; lpBuffer : INPUT_RECORD* out -> "intptr" ; nLength : DWORD -> "int" ; lpNumberOfEventsRead : DWORD* out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procPeekConsoleInputW = kernel32.NewProc("PeekConsoleInputW")
)
// hConsoleInput (HANDLE), lpBuffer (INPUT_RECORD* out), nLength (DWORD), lpNumberOfEventsRead (DWORD* out)
r1, _, err := procPeekConsoleInputW.Call(
uintptr(hConsoleInput),
uintptr(lpBuffer),
uintptr(nLength),
uintptr(lpNumberOfEventsRead),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction PeekConsoleInputW(
hConsoleInput: THandle; // HANDLE
lpBuffer: Pointer; // INPUT_RECORD* out
nLength: DWORD; // DWORD
lpNumberOfEventsRead: Pointer // DWORD* out
): BOOL; stdcall;
external 'KERNEL32.dll' name 'PeekConsoleInputW';result := DllCall("KERNEL32\PeekConsoleInputW"
, "Ptr", hConsoleInput ; HANDLE
, "Ptr", lpBuffer ; INPUT_RECORD* out
, "UInt", nLength ; DWORD
, "Ptr", lpNumberOfEventsRead ; DWORD* out
, "Int") ; return: BOOL●PeekConsoleInputW(hConsoleInput, lpBuffer, nLength, lpNumberOfEventsRead) = DLL("KERNEL32.dll", "bool PeekConsoleInputW(void*, void*, dword, void*)")
# 呼び出し: PeekConsoleInputW(hConsoleInput, lpBuffer, nLength, lpNumberOfEventsRead)
# hConsoleInput : HANDLE -> "void*"
# lpBuffer : INPUT_RECORD* out -> "void*"
# nLength : DWORD -> "dword"
# lpNumberOfEventsRead : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "kernel32" fn PeekConsoleInputW(
hConsoleInput: ?*anyopaque, // HANDLE
lpBuffer: [*c]INPUT_RECORD, // INPUT_RECORD* out
nLength: u32, // DWORD
lpNumberOfEventsRead: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc PeekConsoleInputW(
hConsoleInput: pointer, # HANDLE
lpBuffer: ptr INPUT_RECORD, # INPUT_RECORD* out
nLength: uint32, # DWORD
lpNumberOfEventsRead: ptr uint32 # DWORD* out
): int32 {.importc: "PeekConsoleInputW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "kernel32");
extern(Windows)
int PeekConsoleInputW(
void* hConsoleInput, // HANDLE
INPUT_RECORD* lpBuffer, // INPUT_RECORD* out
uint nLength, // DWORD
uint* lpNumberOfEventsRead // DWORD* out
);ccall((:PeekConsoleInputW, "KERNEL32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{INPUT_RECORD}, UInt32, Ptr{UInt32}),
hConsoleInput, lpBuffer, nLength, lpNumberOfEventsRead)
# hConsoleInput : HANDLE -> Ptr{Cvoid}
# lpBuffer : INPUT_RECORD* out -> Ptr{INPUT_RECORD}
# nLength : DWORD -> UInt32
# lpNumberOfEventsRead : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t PeekConsoleInputW(
void* hConsoleInput,
void* lpBuffer,
uint32_t nLength,
uint32_t* lpNumberOfEventsRead);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.PeekConsoleInputW(hConsoleInput, lpBuffer, nLength, lpNumberOfEventsRead)
-- hConsoleInput : HANDLE
-- lpBuffer : INPUT_RECORD* out
-- nLength : DWORD
-- lpNumberOfEventsRead : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const PeekConsoleInputW = lib.func('__stdcall', 'PeekConsoleInputW', 'int32_t', ['void *', 'void *', 'uint32_t', 'uint32_t *']);
// PeekConsoleInputW(hConsoleInput, lpBuffer, nLength, lpNumberOfEventsRead)
// hConsoleInput : HANDLE -> 'void *'
// lpBuffer : INPUT_RECORD* out -> 'void *'
// nLength : DWORD -> 'uint32_t'
// lpNumberOfEventsRead : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
PeekConsoleInputW: { parameters: ["pointer", "pointer", "u32", "pointer"], result: "i32" },
});
// lib.symbols.PeekConsoleInputW(hConsoleInput, lpBuffer, nLength, lpNumberOfEventsRead)
// hConsoleInput : HANDLE -> "pointer"
// lpBuffer : INPUT_RECORD* out -> "pointer"
// nLength : DWORD -> "u32"
// lpNumberOfEventsRead : DWORD* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t PeekConsoleInputW(
void* hConsoleInput,
void* lpBuffer,
uint32_t nLength,
uint32_t* lpNumberOfEventsRead);
C, "KERNEL32.dll");
// $ffi->PeekConsoleInputW(hConsoleInput, lpBuffer, nLength, lpNumberOfEventsRead);
// hConsoleInput : HANDLE
// lpBuffer : INPUT_RECORD* out
// nLength : DWORD
// lpNumberOfEventsRead : DWORD* out
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;
public interface Kernel32 extends StdCallLibrary {
Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class, W32APIOptions.UNICODE_OPTIONS);
boolean PeekConsoleInputW(
Pointer hConsoleInput, // HANDLE
Pointer lpBuffer, // INPUT_RECORD* out
int nLength, // DWORD
IntByReference lpNumberOfEventsRead // DWORD* out
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("kernel32")]
lib LibKERNEL32
fun PeekConsoleInputW = PeekConsoleInputW(
hConsoleInput : Void*, # HANDLE
lpBuffer : INPUT_RECORD*, # INPUT_RECORD* out
nLength : UInt32, # DWORD
lpNumberOfEventsRead : UInt32* # DWORD* out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef PeekConsoleInputWNative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32, Pointer<Uint32>);
typedef PeekConsoleInputWDart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Uint32>);
final PeekConsoleInputW = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<PeekConsoleInputWNative, PeekConsoleInputWDart>('PeekConsoleInputW');
// hConsoleInput : HANDLE -> Pointer<Void>
// lpBuffer : INPUT_RECORD* out -> Pointer<Void>
// nLength : DWORD -> Uint32
// lpNumberOfEventsRead : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function PeekConsoleInputW(
hConsoleInput: THandle; // HANDLE
lpBuffer: Pointer; // INPUT_RECORD* out
nLength: DWORD; // DWORD
lpNumberOfEventsRead: Pointer // DWORD* out
): BOOL; stdcall;
external 'KERNEL32.dll' name 'PeekConsoleInputW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "PeekConsoleInputW"
c_PeekConsoleInputW :: Ptr () -> Ptr () -> Word32 -> Ptr Word32 -> IO CInt
-- hConsoleInput : HANDLE -> Ptr ()
-- lpBuffer : INPUT_RECORD* out -> Ptr ()
-- nLength : DWORD -> Word32
-- lpNumberOfEventsRead : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let peekconsoleinputw =
foreign "PeekConsoleInputW"
((ptr void) @-> (ptr void) @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* hConsoleInput : HANDLE -> (ptr void) *)
(* lpBuffer : INPUT_RECORD* out -> (ptr void) *)
(* nLength : DWORD -> uint32_t *)
(* lpNumberOfEventsRead : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("PeekConsoleInputW" peek-console-input-w :convention :stdcall) :int32
(h-console-input :pointer) ; HANDLE
(lp-buffer :pointer) ; INPUT_RECORD* out
(n-length :uint32) ; DWORD
(lp-number-of-events-read :pointer)) ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $PeekConsoleInputW = Win32::API::More->new('KERNEL32',
'BOOL PeekConsoleInputW(HANDLE hConsoleInput, LPVOID lpBuffer, DWORD nLength, LPVOID lpNumberOfEventsRead)');
# my $ret = $PeekConsoleInputW->Call($hConsoleInput, $lpBuffer, $nLength, $lpNumberOfEventsRead);
# hConsoleInput : HANDLE -> HANDLE
# lpBuffer : INPUT_RECORD* out -> LPVOID
# nLength : DWORD -> DWORD
# lpNumberOfEventsRead : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f PeekConsoleInputA (ANSI版) — コンソール入力バッファのイベントを削除せず先読みする(ANSI版)。
使用する型