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

ReadConsoleW

関数
コンソール入力から文字データを読み取る(Unicode版)。
DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり

シグネチャ

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL ReadConsoleW(
    HANDLE hConsoleInput,
    void* lpBuffer,
    DWORD nNumberOfCharsToRead,
    DWORD* lpNumberOfCharsRead,
    CONSOLE_READCONSOLE_CONTROL* pInputControl   // optional
);

パラメーター

名前方向
hConsoleInputHANDLEin
lpBuffervoid*out
nNumberOfCharsToReadDWORDin
lpNumberOfCharsReadDWORD*out
pInputControlCONSOLE_READCONSOLE_CONTROL*inoptional

戻り値の型: BOOL

各言語での呼び出し定義

// KERNEL32.dll  (Unicode / -W)
#include <windows.h>

BOOL ReadConsoleW(
    HANDLE hConsoleInput,
    void* lpBuffer,
    DWORD nNumberOfCharsToRead,
    DWORD* lpNumberOfCharsRead,
    CONSOLE_READCONSOLE_CONTROL* pInputControl   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool ReadConsoleW(
    IntPtr hConsoleInput,   // HANDLE
    IntPtr lpBuffer,   // void* out
    uint nNumberOfCharsToRead,   // DWORD
    out uint lpNumberOfCharsRead,   // DWORD* out
    IntPtr pInputControl   // CONSOLE_READCONSOLE_CONTROL* optional
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ReadConsoleW(
    hConsoleInput As IntPtr,   ' HANDLE
    lpBuffer As IntPtr,   ' void* out
    nNumberOfCharsToRead As UInteger,   ' DWORD
    <Out> ByRef lpNumberOfCharsRead As UInteger,   ' DWORD* out
    pInputControl As IntPtr   ' CONSOLE_READCONSOLE_CONTROL* optional
) As Boolean
End Function
' hConsoleInput : HANDLE
' lpBuffer : void* out
' nNumberOfCharsToRead : DWORD
' lpNumberOfCharsRead : DWORD* out
' pInputControl : CONSOLE_READCONSOLE_CONTROL* optional
Declare PtrSafe Function ReadConsoleW Lib "kernel32" ( _
    ByVal hConsoleInput As LongPtr, _
    ByVal lpBuffer As LongPtr, _
    ByVal nNumberOfCharsToRead As Long, _
    ByRef lpNumberOfCharsRead As Long, _
    ByVal pInputControl As LongPtr) 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

ReadConsoleW = ctypes.windll.kernel32.ReadConsoleW
ReadConsoleW.restype = wintypes.BOOL
ReadConsoleW.argtypes = [
    wintypes.HANDLE,  # hConsoleInput : HANDLE
    ctypes.POINTER(None),  # lpBuffer : void* out
    wintypes.DWORD,  # nNumberOfCharsToRead : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpNumberOfCharsRead : DWORD* out
    ctypes.c_void_p,  # pInputControl : CONSOLE_READCONSOLE_CONTROL* optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
ReadConsoleW = Fiddle::Function.new(
  lib['ReadConsoleW'],
  [
    Fiddle::TYPE_VOIDP,  # hConsoleInput : HANDLE
    Fiddle::TYPE_VOIDP,  # lpBuffer : void* out
    -Fiddle::TYPE_INT,  # nNumberOfCharsToRead : DWORD
    Fiddle::TYPE_VOIDP,  # lpNumberOfCharsRead : DWORD* out
    Fiddle::TYPE_VOIDP,  # pInputControl : CONSOLE_READCONSOLE_CONTROL* optional
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "kernel32")]
extern "system" {
    fn ReadConsoleW(
        hConsoleInput: *mut core::ffi::c_void,  // HANDLE
        lpBuffer: *mut (),  // void* out
        nNumberOfCharsToRead: u32,  // DWORD
        lpNumberOfCharsRead: *mut u32,  // DWORD* out
        pInputControl: *mut CONSOLE_READCONSOLE_CONTROL  // CONSOLE_READCONSOLE_CONTROL* optional
    ) -> 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 ReadConsoleW(IntPtr hConsoleInput, IntPtr lpBuffer, uint nNumberOfCharsToRead, out uint lpNumberOfCharsRead, IntPtr pInputControl);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_ReadConsoleW' -Namespace Win32 -PassThru
# $api::ReadConsoleW(hConsoleInput, lpBuffer, nNumberOfCharsToRead, lpNumberOfCharsRead, pInputControl)
#uselib "KERNEL32.dll"
#func global ReadConsoleW "ReadConsoleW" wptr, wptr, wptr, wptr, wptr
; ReadConsoleW hConsoleInput, lpBuffer, nNumberOfCharsToRead, varptr(lpNumberOfCharsRead), varptr(pInputControl)   ; 戻り値は stat
; hConsoleInput : HANDLE -> "wptr"
; lpBuffer : void* out -> "wptr"
; nNumberOfCharsToRead : DWORD -> "wptr"
; lpNumberOfCharsRead : DWORD* out -> "wptr"
; pInputControl : CONSOLE_READCONSOLE_CONTROL* optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global ReadConsoleW "ReadConsoleW" sptr, sptr, int, var, var
; res = ReadConsoleW(hConsoleInput, lpBuffer, nNumberOfCharsToRead, lpNumberOfCharsRead, pInputControl)
; hConsoleInput : HANDLE -> "sptr"
; lpBuffer : void* out -> "sptr"
; nNumberOfCharsToRead : DWORD -> "int"
; lpNumberOfCharsRead : DWORD* out -> "var"
; pInputControl : CONSOLE_READCONSOLE_CONTROL* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL ReadConsoleW(HANDLE hConsoleInput, void* lpBuffer, DWORD nNumberOfCharsToRead, DWORD* lpNumberOfCharsRead, CONSOLE_READCONSOLE_CONTROL* pInputControl)
#uselib "KERNEL32.dll"
#cfunc global ReadConsoleW "ReadConsoleW" intptr, intptr, int, var, var
; res = ReadConsoleW(hConsoleInput, lpBuffer, nNumberOfCharsToRead, lpNumberOfCharsRead, pInputControl)
; hConsoleInput : HANDLE -> "intptr"
; lpBuffer : void* out -> "intptr"
; nNumberOfCharsToRead : DWORD -> "int"
; lpNumberOfCharsRead : DWORD* out -> "var"
; pInputControl : CONSOLE_READCONSOLE_CONTROL* optional -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procReadConsoleW = kernel32.NewProc("ReadConsoleW")
)

// hConsoleInput (HANDLE), lpBuffer (void* out), nNumberOfCharsToRead (DWORD), lpNumberOfCharsRead (DWORD* out), pInputControl (CONSOLE_READCONSOLE_CONTROL* optional)
r1, _, err := procReadConsoleW.Call(
	uintptr(hConsoleInput),
	uintptr(lpBuffer),
	uintptr(nNumberOfCharsToRead),
	uintptr(lpNumberOfCharsRead),
	uintptr(pInputControl),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function ReadConsoleW(
  hConsoleInput: THandle;   // HANDLE
  lpBuffer: Pointer;   // void* out
  nNumberOfCharsToRead: DWORD;   // DWORD
  lpNumberOfCharsRead: Pointer;   // DWORD* out
  pInputControl: Pointer   // CONSOLE_READCONSOLE_CONTROL* optional
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'ReadConsoleW';
result := DllCall("KERNEL32\ReadConsoleW"
    , "Ptr", hConsoleInput   ; HANDLE
    , "Ptr", lpBuffer   ; void* out
    , "UInt", nNumberOfCharsToRead   ; DWORD
    , "Ptr", lpNumberOfCharsRead   ; DWORD* out
    , "Ptr", pInputControl   ; CONSOLE_READCONSOLE_CONTROL* optional
    , "Int")   ; return: BOOL
●ReadConsoleW(hConsoleInput, lpBuffer, nNumberOfCharsToRead, lpNumberOfCharsRead, pInputControl) = DLL("KERNEL32.dll", "bool ReadConsoleW(void*, void*, dword, void*, void*)")
# 呼び出し: ReadConsoleW(hConsoleInput, lpBuffer, nNumberOfCharsToRead, lpNumberOfCharsRead, pInputControl)
# hConsoleInput : HANDLE -> "void*"
# lpBuffer : void* out -> "void*"
# nNumberOfCharsToRead : DWORD -> "dword"
# lpNumberOfCharsRead : DWORD* out -> "void*"
# pInputControl : CONSOLE_READCONSOLE_CONTROL* optional -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。