ホーム › System.Console › ReadConsoleOutputCharacterW
ReadConsoleOutputCharacterW
関数コンソール画面バッファの指定座標から文字列を読み取る(Unicode版)。
シグネチャ
// 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 | 読み取り開始位置の座標を示すCOORD値。 |
| lpNumberOfCharsRead | DWORD* | out | 実際に読み取った文字数を受け取る出力DWORDポインタ。 |
戻り値の型: 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 <MarshalAs(UnmanagedType.Bool)> 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 // BOOLfunction 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 版の利用を推奨。const std = @import("std");
extern "kernel32" fn ReadConsoleOutputCharacterW(
hConsoleOutput: ?*anyopaque, // HANDLE
lpCharacter: [*c]u16, // LPWSTR out
nLength: u32, // DWORD
dwReadCoord: COORD, // COORD
lpNumberOfCharsRead: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc ReadConsoleOutputCharacterW(
hConsoleOutput: pointer, # HANDLE
lpCharacter: ptr uint16, # LPWSTR out
nLength: uint32, # DWORD
dwReadCoord: COORD, # COORD
lpNumberOfCharsRead: ptr uint32 # DWORD* out
): int32 {.importc: "ReadConsoleOutputCharacterW", stdcall, dynlib: "KERNEL32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "kernel32");
extern(Windows)
int ReadConsoleOutputCharacterW(
void* hConsoleOutput, // HANDLE
wchar* lpCharacter, // LPWSTR out
uint nLength, // DWORD
COORD dwReadCoord, // COORD
uint* lpNumberOfCharsRead // DWORD* out
);ccall((:ReadConsoleOutputCharacterW, "KERNEL32.dll"), stdcall, Int32,
(Ptr{Cvoid}, Ptr{UInt16}, UInt32, COORD, Ptr{UInt32}),
hConsoleOutput, lpCharacter, nLength, dwReadCoord, lpNumberOfCharsRead)
# hConsoleOutput : HANDLE -> Ptr{Cvoid}
# lpCharacter : LPWSTR out -> Ptr{UInt16}
# nLength : DWORD -> UInt32
# dwReadCoord : COORD -> COORD
# lpNumberOfCharsRead : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
int32_t ReadConsoleOutputCharacterW(
void* hConsoleOutput,
uint16_t* lpCharacter,
uint32_t nLength,
COORD dwReadCoord,
uint32_t* lpNumberOfCharsRead);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.ReadConsoleOutputCharacterW(hConsoleOutput, lpCharacter, nLength, dwReadCoord, lpNumberOfCharsRead)
-- hConsoleOutput : HANDLE
-- lpCharacter : LPWSTR out
-- nLength : DWORD
-- dwReadCoord : COORD
-- lpNumberOfCharsRead : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const ReadConsoleOutputCharacterW = lib.func('__stdcall', 'ReadConsoleOutputCharacterW', 'int32_t', ['void *', 'uint16_t *', 'uint32_t', 'COORD', 'uint32_t *']);
// ReadConsoleOutputCharacterW(hConsoleOutput, lpCharacter, nLength, dwReadCoord, lpNumberOfCharsRead)
// hConsoleOutput : HANDLE -> 'void *'
// lpCharacter : LPWSTR out -> 'uint16_t *'
// nLength : DWORD -> 'uint32_t'
// dwReadCoord : COORD -> 'COORD'
// lpNumberOfCharsRead : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("KERNEL32.dll", {
ReadConsoleOutputCharacterW: { parameters: ["pointer", "buffer", "u32", "buffer", "pointer"], result: "i32" },
});
// lib.symbols.ReadConsoleOutputCharacterW(hConsoleOutput, lpCharacter, nLength, dwReadCoord, lpNumberOfCharsRead)
// hConsoleOutput : HANDLE -> "pointer"
// lpCharacter : LPWSTR out -> "buffer"
// nLength : DWORD -> "u32"
// dwReadCoord : COORD -> "buffer"
// lpNumberOfCharsRead : DWORD* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t ReadConsoleOutputCharacterW(
void* hConsoleOutput,
uint16_t* lpCharacter,
uint32_t nLength,
COORD dwReadCoord,
uint32_t* lpNumberOfCharsRead);
C, "KERNEL32.dll");
// $ffi->ReadConsoleOutputCharacterW(hConsoleOutput, lpCharacter, nLength, dwReadCoord, lpNumberOfCharsRead);
// hConsoleOutput : HANDLE
// lpCharacter : LPWSTR out
// nLength : DWORD
// dwReadCoord : COORD
// lpNumberOfCharsRead : DWORD* out
// 構造体/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.UNICODE_OPTIONS);
boolean ReadConsoleOutputCharacterW(
Pointer hConsoleOutput, // HANDLE
char[] lpCharacter, // LPWSTR out
int nLength, // DWORD
COORD /* extends Structure (by value) */ dwReadCoord, // COORD
IntByReference lpNumberOfCharsRead // DWORD* out
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("kernel32")]
lib LibKERNEL32
fun ReadConsoleOutputCharacterW = ReadConsoleOutputCharacterW(
hConsoleOutput : Void*, # HANDLE
lpCharacter : UInt16*, # LPWSTR out
nLength : UInt32, # DWORD
dwReadCoord : COORD, # COORD
lpNumberOfCharsRead : UInt32* # DWORD* out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef ReadConsoleOutputCharacterWNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Uint32, COORD, Pointer<Uint32>);
typedef ReadConsoleOutputCharacterWDart = int Function(Pointer<Void>, Pointer<Utf16>, int, int, Pointer<Uint32>);
final ReadConsoleOutputCharacterW = DynamicLibrary.open('KERNEL32.dll')
.lookupFunction<ReadConsoleOutputCharacterWNative, ReadConsoleOutputCharacterWDart>('ReadConsoleOutputCharacterW');
// hConsoleOutput : HANDLE -> Pointer<Void>
// lpCharacter : LPWSTR out -> Pointer<Utf16>
// nLength : DWORD -> Uint32
// dwReadCoord : COORD -> COORD
// lpNumberOfCharsRead : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
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';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "ReadConsoleOutputCharacterW"
c_ReadConsoleOutputCharacterW :: Ptr () -> CWString -> Word32 -> COORD -> Ptr Word32 -> IO CInt
-- hConsoleOutput : HANDLE -> Ptr ()
-- lpCharacter : LPWSTR out -> CWString
-- nLength : DWORD -> Word32
-- dwReadCoord : COORD -> COORD
-- lpNumberOfCharsRead : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。open Ctypes
open Foreign
let readconsoleoutputcharacterw =
foreign "ReadConsoleOutputCharacterW"
((ptr void) @-> (ptr uint16_t) @-> uint32_t @-> COORD @-> (ptr uint32_t) @-> returning int32_t)
(* hConsoleOutput : HANDLE -> (ptr void) *)
(* lpCharacter : LPWSTR out -> (ptr uint16_t) *)
(* nLength : DWORD -> uint32_t *)
(* dwReadCoord : COORD -> COORD *)
(* lpNumberOfCharsRead : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)
(cffi:defcfun ("ReadConsoleOutputCharacterW" read-console-output-character-w :convention :stdcall) :int32
(h-console-output :pointer) ; HANDLE
(lp-character :pointer) ; LPWSTR out
(n-length :uint32) ; DWORD
(dw-read-coord (:struct coord)) ; COORD
(lp-number-of-chars-read :pointer)) ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $ReadConsoleOutputCharacterW = Win32::API::More->new('KERNEL32',
'BOOL ReadConsoleOutputCharacterW(HANDLE hConsoleOutput, LPWSTR lpCharacter, DWORD nLength, LPVOID dwReadCoord, LPVOID lpNumberOfCharsRead)');
# my $ret = $ReadConsoleOutputCharacterW->Call($hConsoleOutput, $lpCharacter, $nLength, $dwReadCoord, $lpNumberOfCharsRead);
# hConsoleOutput : HANDLE -> HANDLE
# lpCharacter : LPWSTR out -> LPWSTR
# nLength : DWORD -> DWORD
# dwReadCoord : COORD -> LPVOID
# lpNumberOfCharsRead : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f ReadConsoleOutputCharacterA (ANSI版) — コンソール画面バッファの指定座標から文字列を読み取る(ANSI版)。
使用する型