Win32 API 日本語リファレンス
ホーム › System.Console › ReadConsoleInputExA

ReadConsoleInputExA

関数
フラグ指定付きでコンソール入力レコードを読み取る拡張関数(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapi
📘 Microsoft Learn (日本語) · English

シグネチャ

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL ReadConsoleInputExA(
    HANDLE hConsoleInput,
    INPUT_RECORD* lpBuffer,
    DWORD nLength,
    DWORD* lpNumberOfEventsRead,
    WORD wFlags
);

パラメーター

名前型方向説明
hConsoleInputHANDLEinコンソール入力バッファのハンドル。読み取りアクセス権を持つ入力ハンドルを指定する。
lpBufferINPUT_RECORD*out読み取った入力イベントを受け取るINPUT_RECORD配列へのポインタ(ANSI)。
nLengthDWORDinlpBufferに格納できるINPUT_RECORD要素の最大個数。
lpNumberOfEventsReadDWORD*out実際に読み取られたイベント数を受け取るDWORDポインタ。
wFlagsWORDin読み取り動作を制御するフラグ。先読み(ピーク)や待機なし等の挙動を指定する。

戻り値の型: BOOL

各言語での呼び出し定義

// KERNEL32.dll  (ANSI / -A)
#include <windows.h>

BOOL ReadConsoleInputExA(
    HANDLE hConsoleInput,
    INPUT_RECORD* lpBuffer,
    DWORD nLength,
    DWORD* lpNumberOfEventsRead,
    WORD wFlags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern bool ReadConsoleInputExA(
    IntPtr hConsoleInput,   // HANDLE
    IntPtr lpBuffer,   // INPUT_RECORD* out
    uint nLength,   // DWORD
    out uint lpNumberOfEventsRead,   // DWORD* out
    ushort wFlags   // WORD
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function ReadConsoleInputExA(
    hConsoleInput As IntPtr,   ' HANDLE
    lpBuffer As IntPtr,   ' INPUT_RECORD* out
    nLength As UInteger,   ' DWORD
    <Out> ByRef lpNumberOfEventsRead As UInteger,   ' DWORD* out
    wFlags As UShort   ' WORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hConsoleInput : HANDLE
' lpBuffer : INPUT_RECORD* out
' nLength : DWORD
' lpNumberOfEventsRead : DWORD* out
' wFlags : WORD
Declare PtrSafe Function ReadConsoleInputExA Lib "kernel32" ( _
    ByVal hConsoleInput As LongPtr, _
    ByVal lpBuffer As LongPtr, _
    ByVal nLength As Long, _
    ByRef lpNumberOfEventsRead As Long, _
    ByVal wFlags As Integer) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ReadConsoleInputExA = ctypes.windll.kernel32.ReadConsoleInputExA
ReadConsoleInputExA.restype = wintypes.BOOL
ReadConsoleInputExA.argtypes = [
    wintypes.HANDLE,  # hConsoleInput : HANDLE
    ctypes.c_void_p,  # lpBuffer : INPUT_RECORD* out
    wintypes.DWORD,  # nLength : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpNumberOfEventsRead : DWORD* out
    ctypes.c_ushort,  # wFlags : WORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
ReadConsoleInputExA = Fiddle::Function.new(
  lib['ReadConsoleInputExA'],
  [
    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_SHORT,  # wFlags : WORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn ReadConsoleInputExA(
        hConsoleInput: *mut core::ffi::c_void,  // HANDLE
        lpBuffer: *mut INPUT_RECORD,  // INPUT_RECORD* out
        nLength: u32,  // DWORD
        lpNumberOfEventsRead: *mut u32,  // DWORD* out
        wFlags: u16  // WORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi)]
public static extern bool ReadConsoleInputExA(IntPtr hConsoleInput, IntPtr lpBuffer, uint nLength, out uint lpNumberOfEventsRead, ushort wFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_ReadConsoleInputExA' -Namespace Win32 -PassThru
# $api::ReadConsoleInputExA(hConsoleInput, lpBuffer, nLength, lpNumberOfEventsRead, wFlags)
#uselib "KERNEL32.dll"
#func global ReadConsoleInputExA "ReadConsoleInputExA" sptr, sptr, sptr, sptr, sptr
; ReadConsoleInputExA hConsoleInput, varptr(lpBuffer), nLength, varptr(lpNumberOfEventsRead), wFlags   ; 戻り値は stat
; hConsoleInput : HANDLE -> "sptr"
; lpBuffer : INPUT_RECORD* out -> "sptr"
; nLength : DWORD -> "sptr"
; lpNumberOfEventsRead : DWORD* out -> "sptr"
; wFlags : WORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "KERNEL32.dll"
#cfunc global ReadConsoleInputExA "ReadConsoleInputExA" sptr, var, int, var, int
; res = ReadConsoleInputExA(hConsoleInput, lpBuffer, nLength, lpNumberOfEventsRead, wFlags)
; hConsoleInput : HANDLE -> "sptr"
; lpBuffer : INPUT_RECORD* out -> "var"
; nLength : DWORD -> "int"
; lpNumberOfEventsRead : DWORD* out -> "var"
; wFlags : WORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; BOOL ReadConsoleInputExA(HANDLE hConsoleInput, INPUT_RECORD* lpBuffer, DWORD nLength, DWORD* lpNumberOfEventsRead, WORD wFlags)
#uselib "KERNEL32.dll"
#cfunc global ReadConsoleInputExA "ReadConsoleInputExA" intptr, var, int, var, int
; res = ReadConsoleInputExA(hConsoleInput, lpBuffer, nLength, lpNumberOfEventsRead, wFlags)
; hConsoleInput : HANDLE -> "intptr"
; lpBuffer : INPUT_RECORD* out -> "var"
; nLength : DWORD -> "int"
; lpNumberOfEventsRead : DWORD* out -> "var"
; wFlags : WORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procReadConsoleInputExA = kernel32.NewProc("ReadConsoleInputExA")
)

// hConsoleInput (HANDLE), lpBuffer (INPUT_RECORD* out), nLength (DWORD), lpNumberOfEventsRead (DWORD* out), wFlags (WORD)
r1, _, err := procReadConsoleInputExA.Call(
	uintptr(hConsoleInput),
	uintptr(lpBuffer),
	uintptr(nLength),
	uintptr(lpNumberOfEventsRead),
	uintptr(wFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function ReadConsoleInputExA(
  hConsoleInput: THandle;   // HANDLE
  lpBuffer: Pointer;   // INPUT_RECORD* out
  nLength: DWORD;   // DWORD
  lpNumberOfEventsRead: Pointer;   // DWORD* out
  wFlags: Word   // WORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'ReadConsoleInputExA';
result := DllCall("KERNEL32\ReadConsoleInputExA"
    , "Ptr", hConsoleInput   ; HANDLE
    , "Ptr", lpBuffer   ; INPUT_RECORD* out
    , "UInt", nLength   ; DWORD
    , "Ptr", lpNumberOfEventsRead   ; DWORD* out
    , "UShort", wFlags   ; WORD
    , "Int")   ; return: BOOL
●ReadConsoleInputExA(hConsoleInput, lpBuffer, nLength, lpNumberOfEventsRead, wFlags) = DLL("KERNEL32.dll", "bool ReadConsoleInputExA(void*, void*, dword, void*, int)")
# 呼び出し: ReadConsoleInputExA(hConsoleInput, lpBuffer, nLength, lpNumberOfEventsRead, wFlags)
# hConsoleInput : HANDLE -> "void*"
# lpBuffer : INPUT_RECORD* out -> "void*"
# nLength : DWORD -> "dword"
# lpNumberOfEventsRead : DWORD* out -> "void*"
# wFlags : WORD -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn ReadConsoleInputExA(
    hConsoleInput: ?*anyopaque, // HANDLE
    lpBuffer: [*c]INPUT_RECORD, // INPUT_RECORD* out
    nLength: u32, // DWORD
    lpNumberOfEventsRead: [*c]u32, // DWORD* out
    wFlags: u16 // WORD
) callconv(std.os.windows.WINAPI) i32;
proc ReadConsoleInputExA(
    hConsoleInput: pointer,  # HANDLE
    lpBuffer: ptr INPUT_RECORD,  # INPUT_RECORD* out
    nLength: uint32,  # DWORD
    lpNumberOfEventsRead: ptr uint32,  # DWORD* out
    wFlags: uint16  # WORD
): int32 {.importc: "ReadConsoleInputExA", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int ReadConsoleInputExA(
    void* hConsoleInput,   // HANDLE
    INPUT_RECORD* lpBuffer,   // INPUT_RECORD* out
    uint nLength,   // DWORD
    uint* lpNumberOfEventsRead,   // DWORD* out
    ushort wFlags   // WORD
);
ccall((:ReadConsoleInputExA, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{INPUT_RECORD}, UInt32, Ptr{UInt32}, UInt16),
      hConsoleInput, lpBuffer, nLength, lpNumberOfEventsRead, wFlags)
# hConsoleInput : HANDLE -> Ptr{Cvoid}
# lpBuffer : INPUT_RECORD* out -> Ptr{INPUT_RECORD}
# nLength : DWORD -> UInt32
# lpNumberOfEventsRead : DWORD* out -> Ptr{UInt32}
# wFlags : WORD -> UInt16
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t ReadConsoleInputExA(
    void* hConsoleInput,
    void* lpBuffer,
    uint32_t nLength,
    uint32_t* lpNumberOfEventsRead,
    uint16_t wFlags);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.ReadConsoleInputExA(hConsoleInput, lpBuffer, nLength, lpNumberOfEventsRead, wFlags)
-- hConsoleInput : HANDLE
-- lpBuffer : INPUT_RECORD* out
-- nLength : DWORD
-- lpNumberOfEventsRead : DWORD* out
-- wFlags : WORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const ReadConsoleInputExA = lib.func('__stdcall', 'ReadConsoleInputExA', 'int32_t', ['void *', 'void *', 'uint32_t', 'uint32_t *', 'uint16_t']);
// ReadConsoleInputExA(hConsoleInput, lpBuffer, nLength, lpNumberOfEventsRead, wFlags)
// hConsoleInput : HANDLE -> 'void *'
// lpBuffer : INPUT_RECORD* out -> 'void *'
// nLength : DWORD -> 'uint32_t'
// lpNumberOfEventsRead : DWORD* out -> 'uint32_t *'
// wFlags : WORD -> 'uint16_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  ReadConsoleInputExA: { parameters: ["pointer", "pointer", "u32", "pointer", "u16"], result: "i32" },
});
// lib.symbols.ReadConsoleInputExA(hConsoleInput, lpBuffer, nLength, lpNumberOfEventsRead, wFlags)
// hConsoleInput : HANDLE -> "pointer"
// lpBuffer : INPUT_RECORD* out -> "pointer"
// nLength : DWORD -> "u32"
// lpNumberOfEventsRead : DWORD* out -> "pointer"
// wFlags : WORD -> "u16"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t ReadConsoleInputExA(
    void* hConsoleInput,
    void* lpBuffer,
    uint32_t nLength,
    uint32_t* lpNumberOfEventsRead,
    uint16_t wFlags);
C, "KERNEL32.dll");
// $ffi->ReadConsoleInputExA(hConsoleInput, lpBuffer, nLength, lpNumberOfEventsRead, wFlags);
// hConsoleInput : HANDLE
// lpBuffer : INPUT_RECORD* out
// nLength : DWORD
// lpNumberOfEventsRead : DWORD* out
// wFlags : WORD
// 構造体/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.ASCII_OPTIONS);
    boolean ReadConsoleInputExA(
        Pointer hConsoleInput,   // HANDLE
        Pointer lpBuffer,   // INPUT_RECORD* out
        int nLength,   // DWORD
        IntByReference lpNumberOfEventsRead,   // DWORD* out
        short wFlags   // WORD
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun ReadConsoleInputExA = ReadConsoleInputExA(
    hConsoleInput : Void*,   # HANDLE
    lpBuffer : INPUT_RECORD*,   # INPUT_RECORD* out
    nLength : UInt32,   # DWORD
    lpNumberOfEventsRead : UInt32*,   # DWORD* out
    wFlags : UInt16   # WORD
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef ReadConsoleInputExANative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32, Pointer<Uint32>, Uint16);
typedef ReadConsoleInputExADart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Uint32>, int);
final ReadConsoleInputExA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<ReadConsoleInputExANative, ReadConsoleInputExADart>('ReadConsoleInputExA');
// hConsoleInput : HANDLE -> Pointer<Void>
// lpBuffer : INPUT_RECORD* out -> Pointer<Void>
// nLength : DWORD -> Uint32
// lpNumberOfEventsRead : DWORD* out -> Pointer<Uint32>
// wFlags : WORD -> Uint16
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ReadConsoleInputExA(
  hConsoleInput: THandle;   // HANDLE
  lpBuffer: Pointer;   // INPUT_RECORD* out
  nLength: DWORD;   // DWORD
  lpNumberOfEventsRead: Pointer;   // DWORD* out
  wFlags: Word   // WORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'ReadConsoleInputExA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ReadConsoleInputExA"
  c_ReadConsoleInputExA :: Ptr () -> Ptr () -> Word32 -> Ptr Word32 -> Word16 -> IO CInt
-- hConsoleInput : HANDLE -> Ptr ()
-- lpBuffer : INPUT_RECORD* out -> Ptr ()
-- nLength : DWORD -> Word32
-- lpNumberOfEventsRead : DWORD* out -> Ptr Word32
-- wFlags : WORD -> Word16
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let readconsoleinputexa =
  foreign "ReadConsoleInputExA"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> (ptr uint32_t) @-> uint16_t @-> returning int32_t)
(* hConsoleInput : HANDLE -> (ptr void) *)
(* lpBuffer : INPUT_RECORD* out -> (ptr void) *)
(* nLength : DWORD -> uint32_t *)
(* lpNumberOfEventsRead : DWORD* out -> (ptr uint32_t) *)
(* wFlags : WORD -> uint16_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("ReadConsoleInputExA" read-console-input-ex-a :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
  (w-flags :uint16))   ; WORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ReadConsoleInputExA = Win32::API::More->new('KERNEL32',
    'BOOL ReadConsoleInputExA(HANDLE hConsoleInput, LPVOID lpBuffer, DWORD nLength, LPVOID lpNumberOfEventsRead, WORD wFlags)');
# my $ret = $ReadConsoleInputExA->Call($hConsoleInput, $lpBuffer, $nLength, $lpNumberOfEventsRead, $wFlags);
# hConsoleInput : HANDLE -> HANDLE
# lpBuffer : INPUT_RECORD* out -> LPVOID
# nLength : DWORD -> DWORD
# lpNumberOfEventsRead : DWORD* out -> LPVOID
# wFlags : WORD -> WORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
類似 API
使用する型