ホーム › System.Console › ReadConsoleOutputCharacterA
ReadConsoleOutputCharacterA
関数コンソール画面バッファの指定座標から文字列を読み取る(ANSI版)。
シグネチャ
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
BOOL ReadConsoleOutputCharacterA(
HANDLE hConsoleOutput,
LPSTR lpCharacter,
DWORD nLength,
COORD dwReadCoord,
DWORD* lpNumberOfCharsRead
);パラメーター
| 名前 | 型 | 方向 |
|---|---|---|
| hConsoleOutput | HANDLE | in |
| lpCharacter | LPSTR | out |
| nLength | DWORD | in |
| dwReadCoord | COORD | in |
| lpNumberOfCharsRead | DWORD* | out |
戻り値の型: BOOL
各言語での呼び出し定義
// KERNEL32.dll (ANSI / -A)
#include <windows.h>
BOOL ReadConsoleOutputCharacterA(
HANDLE hConsoleOutput,
LPSTR lpCharacter,
DWORD nLength,
COORD dwReadCoord,
DWORD* lpNumberOfCharsRead
);[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool ReadConsoleOutputCharacterA(
IntPtr hConsoleOutput, // HANDLE
[MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpCharacter, // LPSTR out
uint nLength, // DWORD
COORD dwReadCoord, // COORD
out uint lpNumberOfCharsRead // DWORD* out
);<DllImport("KERNEL32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ReadConsoleOutputCharacterA(
hConsoleOutput As IntPtr, ' HANDLE
<MarshalAs(UnmanagedType.LPStr)> lpCharacter As System.Text.StringBuilder, ' LPSTR out
nLength As UInteger, ' DWORD
dwReadCoord As COORD, ' COORD
<Out> ByRef lpNumberOfCharsRead As UInteger ' DWORD* out
) As Boolean
End Function' hConsoleOutput : HANDLE
' lpCharacter : LPSTR out
' nLength : DWORD
' dwReadCoord : COORD
' lpNumberOfCharsRead : DWORD* out
Declare PtrSafe Function ReadConsoleOutputCharacterA Lib "kernel32" ( _
ByVal hConsoleOutput As LongPtr, _
ByVal lpCharacter As String, _
ByVal nLength As Long, _
ByVal dwReadCoord As LongPtr, _
ByRef lpNumberOfCharsRead As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
ReadConsoleOutputCharacterA = ctypes.windll.kernel32.ReadConsoleOutputCharacterA
ReadConsoleOutputCharacterA.restype = wintypes.BOOL
ReadConsoleOutputCharacterA.argtypes = [
wintypes.HANDLE, # hConsoleOutput : HANDLE
wintypes.LPSTR, # lpCharacter : LPSTR out
wintypes.DWORD, # nLength : DWORD
COORD, # dwReadCoord : COORD
ctypes.POINTER(wintypes.DWORD), # lpNumberOfCharsRead : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('KERNEL32.dll')
ReadConsoleOutputCharacterA = Fiddle::Function.new(
lib['ReadConsoleOutputCharacterA'],
[
Fiddle::TYPE_VOIDP, # hConsoleOutput : HANDLE
Fiddle::TYPE_VOIDP, # lpCharacter : LPSTR out
-Fiddle::TYPE_INT, # nLength : DWORD
Fiddle::TYPE_VOIDP, # dwReadCoord : COORD
Fiddle::TYPE_VOIDP, # lpNumberOfCharsRead : DWORD* out
],
Fiddle::TYPE_INT)#[link(name = "kernel32")]
extern "system" {
fn ReadConsoleOutputCharacterA(
hConsoleOutput: *mut core::ffi::c_void, // HANDLE
lpCharacter: *mut u8, // LPSTR out
nLength: u32, // DWORD
dwReadCoord: COORD, // COORD
lpNumberOfCharsRead: *mut u32 // DWORD* 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 ReadConsoleOutputCharacterA(IntPtr hConsoleOutput, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpCharacter, uint nLength, COORD dwReadCoord, out uint lpNumberOfCharsRead);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_ReadConsoleOutputCharacterA' -Namespace Win32 -PassThru
# $api::ReadConsoleOutputCharacterA(hConsoleOutput, lpCharacter, nLength, dwReadCoord, lpNumberOfCharsRead)#uselib "KERNEL32.dll"
#func global ReadConsoleOutputCharacterA "ReadConsoleOutputCharacterA" sptr, sptr, sptr, sptr, sptr
; ReadConsoleOutputCharacterA hConsoleOutput, varptr(lpCharacter), nLength, dwReadCoord, varptr(lpNumberOfCharsRead) ; 戻り値は stat
; hConsoleOutput : HANDLE -> "sptr"
; lpCharacter : LPSTR out -> "sptr"
; nLength : DWORD -> "sptr"
; dwReadCoord : COORD -> "sptr"
; lpNumberOfCharsRead : DWORD* out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "KERNEL32.dll" #cfunc global ReadConsoleOutputCharacterA "ReadConsoleOutputCharacterA" sptr, var, int, int, var ; res = ReadConsoleOutputCharacterA(hConsoleOutput, lpCharacter, nLength, dwReadCoord, lpNumberOfCharsRead) ; hConsoleOutput : HANDLE -> "sptr" ; lpCharacter : LPSTR out -> "var" ; nLength : DWORD -> "int" ; dwReadCoord : COORD -> "int" ; lpNumberOfCharsRead : DWORD* out -> "var" ; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。 ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll" #cfunc global ReadConsoleOutputCharacterA "ReadConsoleOutputCharacterA" sptr, sptr, int, int, sptr ; res = ReadConsoleOutputCharacterA(hConsoleOutput, varptr(lpCharacter), nLength, dwReadCoord, varptr(lpNumberOfCharsRead)) ; hConsoleOutput : HANDLE -> "sptr" ; lpCharacter : LPSTR out -> "sptr" ; nLength : DWORD -> "int" ; dwReadCoord : COORD -> "int" ; lpNumberOfCharsRead : DWORD* out -> "sptr" ; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。 ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; BOOL ReadConsoleOutputCharacterA(HANDLE hConsoleOutput, LPSTR lpCharacter, DWORD nLength, COORD dwReadCoord, DWORD* lpNumberOfCharsRead) #uselib "KERNEL32.dll" #cfunc global ReadConsoleOutputCharacterA "ReadConsoleOutputCharacterA" intptr, var, int, int, var ; res = ReadConsoleOutputCharacterA(hConsoleOutput, lpCharacter, nLength, dwReadCoord, lpNumberOfCharsRead) ; hConsoleOutput : HANDLE -> "intptr" ; lpCharacter : LPSTR out -> "var" ; nLength : DWORD -> "int" ; dwReadCoord : COORD -> "int" ; lpNumberOfCharsRead : DWORD* out -> "var" ; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。 ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL ReadConsoleOutputCharacterA(HANDLE hConsoleOutput, LPSTR lpCharacter, DWORD nLength, COORD dwReadCoord, DWORD* lpNumberOfCharsRead) #uselib "KERNEL32.dll" #cfunc global ReadConsoleOutputCharacterA "ReadConsoleOutputCharacterA" intptr, intptr, int, int, intptr ; res = ReadConsoleOutputCharacterA(hConsoleOutput, varptr(lpCharacter), nLength, dwReadCoord, varptr(lpNumberOfCharsRead)) ; hConsoleOutput : HANDLE -> "intptr" ; lpCharacter : LPSTR out -> "intptr" ; nLength : DWORD -> "int" ; dwReadCoord : COORD -> "int" ; lpNumberOfCharsRead : DWORD* out -> "intptr" ; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。 ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
procReadConsoleOutputCharacterA = kernel32.NewProc("ReadConsoleOutputCharacterA")
)
// hConsoleOutput (HANDLE), lpCharacter (LPSTR out), nLength (DWORD), dwReadCoord (COORD), lpNumberOfCharsRead (DWORD* out)
r1, _, err := procReadConsoleOutputCharacterA.Call(
uintptr(hConsoleOutput),
uintptr(lpCharacter),
uintptr(nLength),
uintptr(dwReadCoord),
uintptr(lpNumberOfCharsRead),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // BOOLfunction ReadConsoleOutputCharacterA(
hConsoleOutput: THandle; // HANDLE
lpCharacter: PAnsiChar; // LPSTR out
nLength: DWORD; // DWORD
dwReadCoord: COORD; // COORD
lpNumberOfCharsRead: Pointer // DWORD* out
): BOOL; stdcall;
external 'KERNEL32.dll' name 'ReadConsoleOutputCharacterA';result := DllCall("KERNEL32\ReadConsoleOutputCharacterA"
, "Ptr", hConsoleOutput ; HANDLE
, "Ptr", lpCharacter ; LPSTR out
, "UInt", nLength ; DWORD
, "Ptr", dwReadCoord ; COORD
, "Ptr", lpNumberOfCharsRead ; DWORD* out
, "Int") ; return: BOOL●ReadConsoleOutputCharacterA(hConsoleOutput, lpCharacter, nLength, dwReadCoord, lpNumberOfCharsRead) = DLL("KERNEL32.dll", "bool ReadConsoleOutputCharacterA(void*, char*, dword, void*, void*)")
# 呼び出し: ReadConsoleOutputCharacterA(hConsoleOutput, lpCharacter, nLength, dwReadCoord, lpNumberOfCharsRead)
# hConsoleOutput : HANDLE -> "void*"
# lpCharacter : LPSTR out -> "char*"
# nLength : DWORD -> "dword"
# dwReadCoord : COORD -> "void*"
# lpNumberOfCharsRead : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。