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

ReadConsoleA

関数
コンソール入力から文字データを読み取る(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり
📘 Microsoft Learn (日本語) · English

シグネチャ

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

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

パラメーター

名前型方向説明
hConsoleInputHANDLEinコンソール入力バッファのハンドル。
lpBuffervoid*out読み取った文字データを受け取るバッファへのポインタ。
nNumberOfCharsToReadDWORDin読み取る文字数の上限。
lpNumberOfCharsReadDWORD*out実際に読み取った文字数を受け取る出力DWORDポインタ。
pInputControlCONSOLE_READCONSOLE_CONTROL*inoptional行入力時の制御情報を指定するCONSOLE_READCONSOLE_CONTROL構造体へのポインタ。NULL可。

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL ReadConsoleA(
    HANDLE hConsoleInput,
    void* lpBuffer,
    DWORD nNumberOfCharsToRead,
    DWORD* lpNumberOfCharsRead,
    CONSOLE_READCONSOLE_CONTROL* pInputControl   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool ReadConsoleA(
    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.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ReadConsoleA(
    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 <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hConsoleInput : HANDLE
' lpBuffer : void* out
' nNumberOfCharsToRead : DWORD
' lpNumberOfCharsRead : DWORD* out
' pInputControl : CONSOLE_READCONSOLE_CONTROL* optional
Declare PtrSafe Function ReadConsoleA Lib "kernel32" ( _
    ByVal hConsoleInput As LongPtr, _
    ByVal lpBuffer As LongPtr, _
    ByVal nNumberOfCharsToRead As Long, _
    ByRef lpNumberOfCharsRead As Long, _
    ByVal pInputControl As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ReadConsoleA = ctypes.windll.kernel32.ReadConsoleA
ReadConsoleA.restype = wintypes.BOOL
ReadConsoleA.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')
ReadConsoleA = Fiddle::Function.new(
  lib['ReadConsoleA'],
  [
    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)
#[link(name = "kernel32")]
extern "system" {
    fn ReadConsoleA(
        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.Ansi, SetLastError = true)]
public static extern bool ReadConsoleA(IntPtr hConsoleInput, IntPtr lpBuffer, uint nNumberOfCharsToRead, out uint lpNumberOfCharsRead, IntPtr pInputControl);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_ReadConsoleA' -Namespace Win32 -PassThru
# $api::ReadConsoleA(hConsoleInput, lpBuffer, nNumberOfCharsToRead, lpNumberOfCharsRead, pInputControl)
#uselib "KERNEL32.dll"
#func global ReadConsoleA "ReadConsoleA" sptr, sptr, sptr, sptr, sptr
; ReadConsoleA hConsoleInput, lpBuffer, nNumberOfCharsToRead, varptr(lpNumberOfCharsRead), varptr(pInputControl)   ; 戻り値は stat
; hConsoleInput : HANDLE -> "sptr"
; lpBuffer : void* out -> "sptr"
; nNumberOfCharsToRead : DWORD -> "sptr"
; lpNumberOfCharsRead : DWORD* out -> "sptr"
; pInputControl : CONSOLE_READCONSOLE_CONTROL* optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "KERNEL32.dll"
#cfunc global ReadConsoleA "ReadConsoleA" sptr, sptr, int, var, var
; res = ReadConsoleA(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 ReadConsoleA(HANDLE hConsoleInput, void* lpBuffer, DWORD nNumberOfCharsToRead, DWORD* lpNumberOfCharsRead, CONSOLE_READCONSOLE_CONTROL* pInputControl)
#uselib "KERNEL32.dll"
#cfunc global ReadConsoleA "ReadConsoleA" intptr, intptr, int, var, var
; res = ReadConsoleA(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")
	procReadConsoleA = kernel32.NewProc("ReadConsoleA")
)

// hConsoleInput (HANDLE), lpBuffer (void* out), nNumberOfCharsToRead (DWORD), lpNumberOfCharsRead (DWORD* out), pInputControl (CONSOLE_READCONSOLE_CONTROL* optional)
r1, _, err := procReadConsoleA.Call(
	uintptr(hConsoleInput),
	uintptr(lpBuffer),
	uintptr(nNumberOfCharsToRead),
	uintptr(lpNumberOfCharsRead),
	uintptr(pInputControl),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function ReadConsoleA(
  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 'ReadConsoleA';
result := DllCall("KERNEL32\ReadConsoleA"
    , "Ptr", hConsoleInput   ; HANDLE
    , "Ptr", lpBuffer   ; void* out
    , "UInt", nNumberOfCharsToRead   ; DWORD
    , "Ptr", lpNumberOfCharsRead   ; DWORD* out
    , "Ptr", pInputControl   ; CONSOLE_READCONSOLE_CONTROL* optional
    , "Int")   ; return: BOOL
●ReadConsoleA(hConsoleInput, lpBuffer, nNumberOfCharsToRead, lpNumberOfCharsRead, pInputControl) = DLL("KERNEL32.dll", "bool ReadConsoleA(void*, void*, dword, void*, void*)")
# 呼び出し: ReadConsoleA(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)。
const std = @import("std");

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

typedef ReadConsoleANative = Int32 Function(Pointer<Void>, Pointer<Void>, Uint32, Pointer<Uint32>, Pointer<Void>);
typedef ReadConsoleADart = int Function(Pointer<Void>, Pointer<Void>, int, Pointer<Uint32>, Pointer<Void>);
final ReadConsoleA = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<ReadConsoleANative, ReadConsoleADart>('ReadConsoleA');
// hConsoleInput : HANDLE -> Pointer<Void>
// lpBuffer : void* out -> Pointer<Void>
// nNumberOfCharsToRead : DWORD -> Uint32
// lpNumberOfCharsRead : DWORD* out -> Pointer<Uint32>
// pInputControl : CONSOLE_READCONSOLE_CONTROL* optional -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function ReadConsoleA(
  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 'ReadConsoleA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "ReadConsoleA"
  c_ReadConsoleA :: Ptr () -> Ptr () -> Word32 -> Ptr Word32 -> Ptr () -> IO CInt
-- hConsoleInput : HANDLE -> Ptr ()
-- lpBuffer : void* out -> Ptr ()
-- nNumberOfCharsToRead : DWORD -> Word32
-- lpNumberOfCharsRead : DWORD* out -> Ptr Word32
-- pInputControl : CONSOLE_READCONSOLE_CONTROL* optional -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let readconsolea =
  foreign "ReadConsoleA"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> (ptr uint32_t) @-> (ptr void) @-> returning int32_t)
(* hConsoleInput : HANDLE -> (ptr void) *)
(* lpBuffer : void* out -> (ptr void) *)
(* nNumberOfCharsToRead : DWORD -> uint32_t *)
(* lpNumberOfCharsRead : DWORD* out -> (ptr uint32_t) *)
(* pInputControl : CONSOLE_READCONSOLE_CONTROL* optional -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("ReadConsoleA" read-console-a :convention :stdcall) :int32
  (h-console-input :pointer)   ; HANDLE
  (lp-buffer :pointer)   ; void* out
  (n-number-of-chars-to-read :uint32)   ; DWORD
  (lp-number-of-chars-read :pointer)   ; DWORD* out
  (p-input-control :pointer))   ; CONSOLE_READCONSOLE_CONTROL* optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $ReadConsoleA = Win32::API::More->new('KERNEL32',
    'BOOL ReadConsoleA(HANDLE hConsoleInput, LPVOID lpBuffer, DWORD nNumberOfCharsToRead, LPVOID lpNumberOfCharsRead, LPVOID pInputControl)');
# my $ret = $ReadConsoleA->Call($hConsoleInput, $lpBuffer, $nNumberOfCharsToRead, $lpNumberOfCharsRead, $pInputControl);
# hConsoleInput : HANDLE -> HANDLE
# lpBuffer : void* out -> LPVOID
# nNumberOfCharsToRead : DWORD -> DWORD
# lpNumberOfCharsRead : DWORD* out -> LPVOID
# pInputControl : CONSOLE_READCONSOLE_CONTROL* optional -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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