Win32 API 日本語リファレンス
ホームUI.Accessibility › TextRange_GetText

TextRange_GetText

関数
テキスト範囲の文字列を最大長を指定して取得する。
DLLUIAutomationCore.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

// UIAutomationCore.dll
#include <windows.h>

HRESULT TextRange_GetText(
    HUIATEXTRANGE hobj,
    INT maxLength,
    LPWSTR* pRetVal
);

パラメーター

名前方向説明
hobjHUIATEXTRANGEinテキストを取得する対象の範囲ハンドル。
maxLengthINTin取得する最大文字数。-1で範囲全体を取得する。
pRetValLPWSTR*inout取得したテキスト文字列を受け取る出力先。呼び出し側が解放する。

戻り値の型: HRESULT

各言語での呼び出し定義

// UIAutomationCore.dll
#include <windows.h>

HRESULT TextRange_GetText(
    HUIATEXTRANGE hobj,
    INT maxLength,
    LPWSTR* pRetVal
);
[DllImport("UIAutomationCore.dll", ExactSpelling = true)]
static extern int TextRange_GetText(
    IntPtr hobj,   // HUIATEXTRANGE
    int maxLength,   // INT
    IntPtr pRetVal   // LPWSTR* in/out
);
<DllImport("UIAutomationCore.dll", ExactSpelling:=True)>
Public Shared Function TextRange_GetText(
    hobj As IntPtr,   ' HUIATEXTRANGE
    maxLength As Integer,   ' INT
    pRetVal As IntPtr   ' LPWSTR* in/out
) As Integer
End Function
' hobj : HUIATEXTRANGE
' maxLength : INT
' pRetVal : LPWSTR* in/out
Declare PtrSafe Function TextRange_GetText Lib "uiautomationcore" ( _
    ByVal hobj As LongPtr, _
    ByVal maxLength As Long, _
    ByVal pRetVal As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

TextRange_GetText = ctypes.windll.uiautomationcore.TextRange_GetText
TextRange_GetText.restype = ctypes.c_int
TextRange_GetText.argtypes = [
    wintypes.HANDLE,  # hobj : HUIATEXTRANGE
    ctypes.c_int,  # maxLength : INT
    ctypes.c_void_p,  # pRetVal : LPWSTR* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('UIAutomationCore.dll')
TextRange_GetText = Fiddle::Function.new(
  lib['TextRange_GetText'],
  [
    Fiddle::TYPE_VOIDP,  # hobj : HUIATEXTRANGE
    Fiddle::TYPE_INT,  # maxLength : INT
    Fiddle::TYPE_VOIDP,  # pRetVal : LPWSTR* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "uiautomationcore")]
extern "system" {
    fn TextRange_GetText(
        hobj: *mut core::ffi::c_void,  // HUIATEXTRANGE
        maxLength: i32,  // INT
        pRetVal: *mut *mut u16  // LPWSTR* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("UIAutomationCore.dll")]
public static extern int TextRange_GetText(IntPtr hobj, int maxLength, IntPtr pRetVal);
"@
$api = Add-Type -MemberDefinition $sig -Name 'UIAutomationCore_TextRange_GetText' -Namespace Win32 -PassThru
# $api::TextRange_GetText(hobj, maxLength, pRetVal)
#uselib "UIAutomationCore.dll"
#func global TextRange_GetText "TextRange_GetText" sptr, sptr, sptr
; TextRange_GetText hobj, maxLength, varptr(pRetVal)   ; 戻り値は stat
; hobj : HUIATEXTRANGE -> "sptr"
; maxLength : INT -> "sptr"
; pRetVal : LPWSTR* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "UIAutomationCore.dll"
#cfunc global TextRange_GetText "TextRange_GetText" sptr, int, var
; res = TextRange_GetText(hobj, maxLength, pRetVal)
; hobj : HUIATEXTRANGE -> "sptr"
; maxLength : INT -> "int"
; pRetVal : LPWSTR* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT TextRange_GetText(HUIATEXTRANGE hobj, INT maxLength, LPWSTR* pRetVal)
#uselib "UIAutomationCore.dll"
#cfunc global TextRange_GetText "TextRange_GetText" intptr, int, var
; res = TextRange_GetText(hobj, maxLength, pRetVal)
; hobj : HUIATEXTRANGE -> "intptr"
; maxLength : INT -> "int"
; pRetVal : LPWSTR* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	uiautomationcore = windows.NewLazySystemDLL("UIAutomationCore.dll")
	procTextRange_GetText = uiautomationcore.NewProc("TextRange_GetText")
)

// hobj (HUIATEXTRANGE), maxLength (INT), pRetVal (LPWSTR* in/out)
r1, _, err := procTextRange_GetText.Call(
	uintptr(hobj),
	uintptr(maxLength),
	uintptr(pRetVal),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function TextRange_GetText(
  hobj: THandle;   // HUIATEXTRANGE
  maxLength: Integer;   // INT
  pRetVal: PPWideChar   // LPWSTR* in/out
): Integer; stdcall;
  external 'UIAutomationCore.dll' name 'TextRange_GetText';
result := DllCall("UIAutomationCore\TextRange_GetText"
    , "Ptr", hobj   ; HUIATEXTRANGE
    , "Int", maxLength   ; INT
    , "Ptr", pRetVal   ; LPWSTR* in/out
    , "Int")   ; return: HRESULT
●TextRange_GetText(hobj, maxLength, pRetVal) = DLL("UIAutomationCore.dll", "int TextRange_GetText(void*, int, void*)")
# 呼び出し: TextRange_GetText(hobj, maxLength, pRetVal)
# hobj : HUIATEXTRANGE -> "void*"
# maxLength : INT -> "int"
# pRetVal : LPWSTR* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "uiautomationcore" fn TextRange_GetText(
    hobj: ?*anyopaque, // HUIATEXTRANGE
    maxLength: i32, // INT
    pRetVal: [*c][*c]u16 // LPWSTR* in/out
) callconv(std.os.windows.WINAPI) i32;
proc TextRange_GetText(
    hobj: pointer,  # HUIATEXTRANGE
    maxLength: int32,  # INT
    pRetVal: ptr WideCString  # LPWSTR* in/out
): int32 {.importc: "TextRange_GetText", stdcall, dynlib: "UIAutomationCore.dll".}
pragma(lib, "uiautomationcore");
extern(Windows)
int TextRange_GetText(
    void* hobj,   // HUIATEXTRANGE
    int maxLength,   // INT
    wchar** pRetVal   // LPWSTR* in/out
);
ccall((:TextRange_GetText, "UIAutomationCore.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Int32, Ptr{Ptr{UInt16}}),
      hobj, maxLength, pRetVal)
# hobj : HUIATEXTRANGE -> Ptr{Cvoid}
# maxLength : INT -> Int32
# pRetVal : LPWSTR* in/out -> Ptr{Ptr{UInt16}}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t TextRange_GetText(
    void* hobj,
    int32_t maxLength,
    uint16_t** pRetVal);
]]
local uiautomationcore = ffi.load("uiautomationcore")
-- uiautomationcore.TextRange_GetText(hobj, maxLength, pRetVal)
-- hobj : HUIATEXTRANGE
-- maxLength : INT
-- pRetVal : LPWSTR* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('UIAutomationCore.dll');
const TextRange_GetText = lib.func('__stdcall', 'TextRange_GetText', 'int32_t', ['void *', 'int32_t', 'void *']);
// TextRange_GetText(hobj, maxLength, pRetVal)
// hobj : HUIATEXTRANGE -> 'void *'
// maxLength : INT -> 'int32_t'
// pRetVal : LPWSTR* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("UIAutomationCore.dll", {
  TextRange_GetText: { parameters: ["pointer", "i32", "pointer"], result: "i32" },
});
// lib.symbols.TextRange_GetText(hobj, maxLength, pRetVal)
// hobj : HUIATEXTRANGE -> "pointer"
// maxLength : INT -> "i32"
// pRetVal : LPWSTR* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t TextRange_GetText(
    void* hobj,
    int32_t maxLength,
    uint16_t** pRetVal);
C, "UIAutomationCore.dll");
// $ffi->TextRange_GetText(hobj, maxLength, pRetVal);
// hobj : HUIATEXTRANGE
// maxLength : INT
// pRetVal : LPWSTR* in/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 Uiautomationcore extends StdCallLibrary {
    Uiautomationcore INSTANCE = Native.load("uiautomationcore", Uiautomationcore.class);
    int TextRange_GetText(
        Pointer hobj,   // HUIATEXTRANGE
        int maxLength,   // INT
        PointerByReference pRetVal   // LPWSTR* in/out
    );
}
@[Link("uiautomationcore")]
lib LibUIAutomationCore
  fun TextRange_GetText = TextRange_GetText(
    hobj : Void*,   # HUIATEXTRANGE
    maxLength : Int32,   # INT
    pRetVal : UInt16**   # LPWSTR* in/out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef TextRange_GetTextNative = Int32 Function(Pointer<Void>, Int32, Pointer<Pointer<Utf16>>);
typedef TextRange_GetTextDart = int Function(Pointer<Void>, int, Pointer<Pointer<Utf16>>);
final TextRange_GetText = DynamicLibrary.open('UIAutomationCore.dll')
    .lookupFunction<TextRange_GetTextNative, TextRange_GetTextDart>('TextRange_GetText');
// hobj : HUIATEXTRANGE -> Pointer<Void>
// maxLength : INT -> Int32
// pRetVal : LPWSTR* in/out -> Pointer<Pointer<Utf16>>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function TextRange_GetText(
  hobj: THandle;   // HUIATEXTRANGE
  maxLength: Integer;   // INT
  pRetVal: PPWideChar   // LPWSTR* in/out
): Integer; stdcall;
  external 'UIAutomationCore.dll' name 'TextRange_GetText';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "TextRange_GetText"
  c_TextRange_GetText :: Ptr () -> Int32 -> Ptr CWString -> IO Int32
-- hobj : HUIATEXTRANGE -> Ptr ()
-- maxLength : INT -> Int32
-- pRetVal : LPWSTR* in/out -> Ptr CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let textrange_gettext =
  foreign "TextRange_GetText"
    ((ptr void) @-> int32_t @-> (ptr (ptr uint16_t)) @-> returning int32_t)
(* hobj : HUIATEXTRANGE -> (ptr void) *)
(* maxLength : INT -> int32_t *)
(* pRetVal : LPWSTR* in/out -> (ptr (ptr uint16_t)) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library uiautomationcore (t "UIAutomationCore.dll"))
(cffi:use-foreign-library uiautomationcore)

(cffi:defcfun ("TextRange_GetText" text-range-get-text :convention :stdcall) :int32
  (hobj :pointer)   ; HUIATEXTRANGE
  (max-length :int32)   ; INT
  (p-ret-val :pointer))   ; LPWSTR* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TextRange_GetText = Win32::API::More->new('UIAutomationCore',
    'int TextRange_GetText(HANDLE hobj, int maxLength, LPVOID pRetVal)');
# my $ret = $TextRange_GetText->Call($hobj, $maxLength, $pRetVal);
# hobj : HUIATEXTRANGE -> HANDLE
# maxLength : INT -> int
# pRetVal : LPWSTR* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。