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

ReadConsoleOutputA

関数
コンソール画面バッファから文字と属性の矩形ブロックを読み取る(ANSI版)。
DLLKERNEL32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL ReadConsoleOutputA(
    HANDLE hConsoleOutput,
    CHAR_INFO* lpBuffer,
    COORD dwBufferSize,
    COORD dwBufferCoord,
    SMALL_RECT* lpReadRegion
);

パラメーター

名前方向
hConsoleOutputHANDLEin
lpBufferCHAR_INFO*out
dwBufferSizeCOORDin
dwBufferCoordCOORDin
lpReadRegionSMALL_RECT*inout

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL ReadConsoleOutputA(
    HANDLE hConsoleOutput,
    CHAR_INFO* lpBuffer,
    COORD dwBufferSize,
    COORD dwBufferCoord,
    SMALL_RECT* lpReadRegion
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool ReadConsoleOutputA(
    IntPtr hConsoleOutput,   // HANDLE
    IntPtr lpBuffer,   // CHAR_INFO* out
    COORD dwBufferSize,   // COORD
    COORD dwBufferCoord,   // COORD
    IntPtr lpReadRegion   // SMALL_RECT* in/out
);
<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ReadConsoleOutputA(
    hConsoleOutput As IntPtr,   ' HANDLE
    lpBuffer As IntPtr,   ' CHAR_INFO* out
    dwBufferSize As COORD,   ' COORD
    dwBufferCoord As COORD,   ' COORD
    lpReadRegion As IntPtr   ' SMALL_RECT* in/out
) As Boolean
End Function
' hConsoleOutput : HANDLE
' lpBuffer : CHAR_INFO* out
' dwBufferSize : COORD
' dwBufferCoord : COORD
' lpReadRegion : SMALL_RECT* in/out
Declare PtrSafe Function ReadConsoleOutputA Lib "kernel32" ( _
    ByVal hConsoleOutput As LongPtr, _
    ByVal lpBuffer As LongPtr, _
    ByVal dwBufferSize As LongPtr, _
    ByVal dwBufferCoord As LongPtr, _
    ByVal lpReadRegion As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

ReadConsoleOutputA = ctypes.windll.kernel32.ReadConsoleOutputA
ReadConsoleOutputA.restype = wintypes.BOOL
ReadConsoleOutputA.argtypes = [
    wintypes.HANDLE,  # hConsoleOutput : HANDLE
    ctypes.c_void_p,  # lpBuffer : CHAR_INFO* out
    COORD,  # dwBufferSize : COORD
    COORD,  # dwBufferCoord : COORD
    ctypes.c_void_p,  # lpReadRegion : SMALL_RECT* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
ReadConsoleOutputA = Fiddle::Function.new(
  lib['ReadConsoleOutputA'],
  [
    Fiddle::TYPE_VOIDP,  # hConsoleOutput : HANDLE
    Fiddle::TYPE_VOIDP,  # lpBuffer : CHAR_INFO* out
    Fiddle::TYPE_VOIDP,  # dwBufferSize : COORD
    Fiddle::TYPE_VOIDP,  # dwBufferCoord : COORD
    Fiddle::TYPE_VOIDP,  # lpReadRegion : SMALL_RECT* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn ReadConsoleOutputA(
        hConsoleOutput: *mut core::ffi::c_void,  // HANDLE
        lpBuffer: *mut CHAR_INFO,  // CHAR_INFO* out
        dwBufferSize: COORD,  // COORD
        dwBufferCoord: COORD,  // COORD
        lpReadRegion: *mut SMALL_RECT  // SMALL_RECT* in/out
    ) -> 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 ReadConsoleOutputA(IntPtr hConsoleOutput, IntPtr lpBuffer, COORD dwBufferSize, COORD dwBufferCoord, IntPtr lpReadRegion);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_ReadConsoleOutputA' -Namespace Win32 -PassThru
# $api::ReadConsoleOutputA(hConsoleOutput, lpBuffer, dwBufferSize, dwBufferCoord, lpReadRegion)
#uselib "KERNEL32.dll"
#func global ReadConsoleOutputA "ReadConsoleOutputA" sptr, sptr, sptr, sptr, sptr
; ReadConsoleOutputA hConsoleOutput, varptr(lpBuffer), dwBufferSize, dwBufferCoord, varptr(lpReadRegion)   ; 戻り値は stat
; hConsoleOutput : HANDLE -> "sptr"
; lpBuffer : CHAR_INFO* out -> "sptr"
; dwBufferSize : COORD -> "sptr"
; dwBufferCoord : COORD -> "sptr"
; lpReadRegion : SMALL_RECT* in/out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global ReadConsoleOutputA "ReadConsoleOutputA" sptr, var, int, int, var
; res = ReadConsoleOutputA(hConsoleOutput, lpBuffer, dwBufferSize, dwBufferCoord, lpReadRegion)
; hConsoleOutput : HANDLE -> "sptr"
; lpBuffer : CHAR_INFO* out -> "var"
; dwBufferSize : COORD -> "int"
; dwBufferCoord : COORD -> "int"
; lpReadRegion : SMALL_RECT* in/out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL ReadConsoleOutputA(HANDLE hConsoleOutput, CHAR_INFO* lpBuffer, COORD dwBufferSize, COORD dwBufferCoord, SMALL_RECT* lpReadRegion)
#uselib "KERNEL32.dll"
#cfunc global ReadConsoleOutputA "ReadConsoleOutputA" intptr, var, int, int, var
; res = ReadConsoleOutputA(hConsoleOutput, lpBuffer, dwBufferSize, dwBufferCoord, lpReadRegion)
; hConsoleOutput : HANDLE -> "intptr"
; lpBuffer : CHAR_INFO* out -> "var"
; dwBufferSize : COORD -> "int"
; dwBufferCoord : COORD -> "int"
; lpReadRegion : SMALL_RECT* in/out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procReadConsoleOutputA = kernel32.NewProc("ReadConsoleOutputA")
)

// hConsoleOutput (HANDLE), lpBuffer (CHAR_INFO* out), dwBufferSize (COORD), dwBufferCoord (COORD), lpReadRegion (SMALL_RECT* in/out)
r1, _, err := procReadConsoleOutputA.Call(
	uintptr(hConsoleOutput),
	uintptr(lpBuffer),
	uintptr(dwBufferSize),
	uintptr(dwBufferCoord),
	uintptr(lpReadRegion),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function ReadConsoleOutputA(
  hConsoleOutput: THandle;   // HANDLE
  lpBuffer: Pointer;   // CHAR_INFO* out
  dwBufferSize: COORD;   // COORD
  dwBufferCoord: COORD;   // COORD
  lpReadRegion: Pointer   // SMALL_RECT* in/out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'ReadConsoleOutputA';
result := DllCall("KERNEL32\ReadConsoleOutputA"
    , "Ptr", hConsoleOutput   ; HANDLE
    , "Ptr", lpBuffer   ; CHAR_INFO* out
    , "Ptr", dwBufferSize   ; COORD
    , "Ptr", dwBufferCoord   ; COORD
    , "Ptr", lpReadRegion   ; SMALL_RECT* in/out
    , "Int")   ; return: BOOL
●ReadConsoleOutputA(hConsoleOutput, lpBuffer, dwBufferSize, dwBufferCoord, lpReadRegion) = DLL("KERNEL32.dll", "bool ReadConsoleOutputA(void*, void*, void*, void*, void*)")
# 呼び出し: ReadConsoleOutputA(hConsoleOutput, lpBuffer, dwBufferSize, dwBufferCoord, lpReadRegion)
# hConsoleOutput : HANDLE -> "void*"
# lpBuffer : CHAR_INFO* out -> "void*"
# dwBufferSize : COORD -> "void*"
# dwBufferCoord : COORD -> "void*"
# lpReadRegion : SMALL_RECT* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。