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

ReadConsoleInputExA

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

シグネチャ

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

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

パラメーター

名前方向
hConsoleInputHANDLEin
lpBufferINPUT_RECORD*out
nLengthDWORDin
lpNumberOfEventsReadDWORD*out
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 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)。