ホーム › System.Console › ReadConsoleOutputCharacterW

ReadConsoleOutputCharacterW

関数

コンソール画面バッファの指定座標から文字列を読み取る(Unicode版)。

DLLKERNEL32.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり

シグネチャ

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

BOOL ReadConsoleOutputCharacterW(
    HANDLE hConsoleOutput,
    LPWSTR lpCharacter,
    DWORD nLength,
    COORD dwReadCoord,
    DWORD* lpNumberOfCharsRead
);

パラメーター

名前	型	方向
hConsoleOutput	HANDLE	in
lpCharacter	LPWSTR	out
nLength	DWORD	in
dwReadCoord	COORD	in
lpNumberOfCharsRead	DWORD*	out

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL ReadConsoleOutputCharacterW(
    HANDLE hConsoleOutput,
    LPWSTR lpCharacter,
    DWORD nLength,
    COORD dwReadCoord,
    DWORD* lpNumberOfCharsRead
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool ReadConsoleOutputCharacterW(
    IntPtr hConsoleOutput,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpCharacter,   // LPWSTR out
    uint nLength,   // DWORD
    COORD dwReadCoord,   // COORD
    out uint lpNumberOfCharsRead   // DWORD* out
);

<DllImport("KERNEL32.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ReadConsoleOutputCharacterW(
    hConsoleOutput As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> lpCharacter As System.Text.StringBuilder,   ' LPWSTR out
    nLength As UInteger,   ' DWORD
    dwReadCoord As COORD,   ' COORD
    <Out> ByRef lpNumberOfCharsRead As UInteger   ' DWORD* out
) As Boolean
End Function

' hConsoleOutput : HANDLE
' lpCharacter : LPWSTR out
' nLength : DWORD
' dwReadCoord : COORD
' lpNumberOfCharsRead : DWORD* out
Declare PtrSafe Function ReadConsoleOutputCharacterW Lib "kernel32" ( _
    ByVal hConsoleOutput As LongPtr, _
    ByVal lpCharacter As LongPtr, _
    ByVal nLength As Long, _
    ByVal dwReadCoord As LongPtr, _
    ByRef lpNumberOfCharsRead As Long) 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

ReadConsoleOutputCharacterW = ctypes.windll.kernel32.ReadConsoleOutputCharacterW
ReadConsoleOutputCharacterW.restype = wintypes.BOOL
ReadConsoleOutputCharacterW.argtypes = [
    wintypes.HANDLE,  # hConsoleOutput : HANDLE
    wintypes.LPWSTR,  # lpCharacter : LPWSTR 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')
ReadConsoleOutputCharacterW = Fiddle::Function.new(
  lib['ReadConsoleOutputCharacterW'],
  [
    Fiddle::TYPE_VOIDP,  # hConsoleOutput : HANDLE
    Fiddle::TYPE_VOIDP,  # lpCharacter : LPWSTR out
    -Fiddle::TYPE_INT,  # nLength : DWORD
    Fiddle::TYPE_VOIDP,  # dwReadCoord : COORD
    Fiddle::TYPE_VOIDP,  # lpNumberOfCharsRead : DWORD* out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "kernel32")]
extern "system" {
    fn ReadConsoleOutputCharacterW(
        hConsoleOutput: *mut core::ffi::c_void,  // HANDLE
        lpCharacter: *mut u16,  // LPWSTR 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.Unicode, SetLastError = true)]
public static extern bool ReadConsoleOutputCharacterW(IntPtr hConsoleOutput, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpCharacter, uint nLength, COORD dwReadCoord, out uint lpNumberOfCharsRead);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_ReadConsoleOutputCharacterW' -Namespace Win32 -PassThru
# $api::ReadConsoleOutputCharacterW(hConsoleOutput, lpCharacter, nLength, dwReadCoord, lpNumberOfCharsRead)

#uselib "KERNEL32.dll"
#func global ReadConsoleOutputCharacterW "ReadConsoleOutputCharacterW" wptr, wptr, wptr, wptr, wptr
; ReadConsoleOutputCharacterW hConsoleOutput, varptr(lpCharacter), nLength, dwReadCoord, varptr(lpNumberOfCharsRead)   ; 戻り値は stat
; hConsoleOutput : HANDLE -> "wptr"
; lpCharacter : LPWSTR out -> "wptr"
; nLength : DWORD -> "wptr"
; dwReadCoord : COORD -> "wptr"
; lpNumberOfCharsRead : DWORD* out -> "wptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global ReadConsoleOutputCharacterW "ReadConsoleOutputCharacterW" sptr, var, int, int, var
; res = ReadConsoleOutputCharacterW(hConsoleOutput, lpCharacter, nLength, dwReadCoord, lpNumberOfCharsRead)
; hConsoleOutput : HANDLE -> "sptr"
; lpCharacter : LPWSTR out -> "var"
; nLength : DWORD -> "int"
; dwReadCoord : COORD -> "int"
; lpNumberOfCharsRead : DWORD* out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global ReadConsoleOutputCharacterW "ReadConsoleOutputCharacterW" sptr, sptr, int, int, sptr
; res = ReadConsoleOutputCharacterW(hConsoleOutput, varptr(lpCharacter), nLength, dwReadCoord, varptr(lpNumberOfCharsRead))
; hConsoleOutput : HANDLE -> "sptr"
; lpCharacter : LPWSTR out -> "sptr"
; nLength : DWORD -> "int"
; dwReadCoord : COORD -> "int"
; lpNumberOfCharsRead : DWORD* out -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; BOOL ReadConsoleOutputCharacterW(HANDLE hConsoleOutput, LPWSTR lpCharacter, DWORD nLength, COORD dwReadCoord, DWORD* lpNumberOfCharsRead)
#uselib "KERNEL32.dll"
#cfunc global ReadConsoleOutputCharacterW "ReadConsoleOutputCharacterW" intptr, var, int, int, var
; res = ReadConsoleOutputCharacterW(hConsoleOutput, lpCharacter, nLength, dwReadCoord, lpNumberOfCharsRead)
; hConsoleOutput : HANDLE -> "intptr"
; lpCharacter : LPWSTR out -> "var"
; nLength : DWORD -> "int"
; dwReadCoord : COORD -> "int"
; lpNumberOfCharsRead : DWORD* out -> "var"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; BOOL ReadConsoleOutputCharacterW(HANDLE hConsoleOutput, LPWSTR lpCharacter, DWORD nLength, COORD dwReadCoord, DWORD* lpNumberOfCharsRead)
#uselib "KERNEL32.dll"
#cfunc global ReadConsoleOutputCharacterW "ReadConsoleOutputCharacterW" intptr, intptr, int, int, intptr
; res = ReadConsoleOutputCharacterW(hConsoleOutput, varptr(lpCharacter), nLength, dwReadCoord, varptr(lpNumberOfCharsRead))
; hConsoleOutput : HANDLE -> "intptr"
; lpCharacter : LPWSTR 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")
	procReadConsoleOutputCharacterW = kernel32.NewProc("ReadConsoleOutputCharacterW")
)

// hConsoleOutput (HANDLE), lpCharacter (LPWSTR out), nLength (DWORD), dwReadCoord (COORD), lpNumberOfCharsRead (DWORD* out)
r1, _, err := procReadConsoleOutputCharacterW.Call(
	uintptr(hConsoleOutput),
	uintptr(lpCharacter),
	uintptr(nLength),
	uintptr(dwReadCoord),
	uintptr(lpNumberOfCharsRead),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function ReadConsoleOutputCharacterW(
  hConsoleOutput: THandle;   // HANDLE
  lpCharacter: PWideChar;   // LPWSTR out
  nLength: DWORD;   // DWORD
  dwReadCoord: COORD;   // COORD
  lpNumberOfCharsRead: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'ReadConsoleOutputCharacterW';

result := DllCall("KERNEL32\ReadConsoleOutputCharacterW"
    , "Ptr", hConsoleOutput   ; HANDLE
    , "Ptr", lpCharacter   ; LPWSTR out
    , "UInt", nLength   ; DWORD
    , "Ptr", dwReadCoord   ; COORD
    , "Ptr", lpNumberOfCharsRead   ; DWORD* out
    , "Int")   ; return: BOOL

●ReadConsoleOutputCharacterW(hConsoleOutput, lpCharacter, nLength, dwReadCoord, lpNumberOfCharsRead) = DLL("KERNEL32.dll", "bool ReadConsoleOutputCharacterW(void*, char*, dword, void*, void*)")
# 呼び出し: ReadConsoleOutputCharacterW(hConsoleOutput, lpCharacter, nLength, dwReadCoord, lpNumberOfCharsRead)
# hConsoleOutput : HANDLE -> "void*"
# lpCharacter : LPWSTR out -> "char*"
# nLength : DWORD -> "dword"
# dwReadCoord : COORD -> "void*"
# lpNumberOfCharsRead : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。