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

TextRange_FindText

関数
範囲内から指定テキストを検索し一致範囲を取得する。
DLLUIAutomationCore.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT TextRange_FindText(
    HUIATEXTRANGE hobj,
    LPWSTR text,
    BOOL backward,
    BOOL ignoreCase,
    HUIATEXTRANGE* pRetVal
);

パラメーター

名前方向説明
hobjHUIATEXTRANGEin検索対象のテキスト範囲ハンドル。
textLPWSTRin検索する文字列(Unicode)。
backwardBOOLin検索方向を指定する(TRUEで後方検索)。
ignoreCaseBOOLin大文字小文字を区別しないかを指定する(TRUEで無視)。
pRetValHUIATEXTRANGE*inout一致したテキスト部分範囲のハンドルを受け取る出力先。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT TextRange_FindText(
    HUIATEXTRANGE hobj,
    LPWSTR text,
    BOOL backward,
    BOOL ignoreCase,
    HUIATEXTRANGE* pRetVal
);
[DllImport("UIAutomationCore.dll", ExactSpelling = true)]
static extern int TextRange_FindText(
    IntPtr hobj,   // HUIATEXTRANGE
    [MarshalAs(UnmanagedType.LPWStr)] string text,   // LPWSTR
    bool backward,   // BOOL
    bool ignoreCase,   // BOOL
    IntPtr pRetVal   // HUIATEXTRANGE* in/out
);
<DllImport("UIAutomationCore.dll", ExactSpelling:=True)>
Public Shared Function TextRange_FindText(
    hobj As IntPtr,   ' HUIATEXTRANGE
    <MarshalAs(UnmanagedType.LPWStr)> text As String,   ' LPWSTR
    backward As Boolean,   ' BOOL
    ignoreCase As Boolean,   ' BOOL
    pRetVal As IntPtr   ' HUIATEXTRANGE* in/out
) As Integer
End Function
' hobj : HUIATEXTRANGE
' text : LPWSTR
' backward : BOOL
' ignoreCase : BOOL
' pRetVal : HUIATEXTRANGE* in/out
Declare PtrSafe Function TextRange_FindText Lib "uiautomationcore" ( _
    ByVal hobj As LongPtr, _
    ByVal text As LongPtr, _
    ByVal backward As Long, _
    ByVal ignoreCase 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_FindText = ctypes.windll.uiautomationcore.TextRange_FindText
TextRange_FindText.restype = ctypes.c_int
TextRange_FindText.argtypes = [
    wintypes.HANDLE,  # hobj : HUIATEXTRANGE
    wintypes.LPCWSTR,  # text : LPWSTR
    wintypes.BOOL,  # backward : BOOL
    wintypes.BOOL,  # ignoreCase : BOOL
    ctypes.c_void_p,  # pRetVal : HUIATEXTRANGE* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('UIAutomationCore.dll')
TextRange_FindText = Fiddle::Function.new(
  lib['TextRange_FindText'],
  [
    Fiddle::TYPE_VOIDP,  # hobj : HUIATEXTRANGE
    Fiddle::TYPE_VOIDP,  # text : LPWSTR
    Fiddle::TYPE_INT,  # backward : BOOL
    Fiddle::TYPE_INT,  # ignoreCase : BOOL
    Fiddle::TYPE_VOIDP,  # pRetVal : HUIATEXTRANGE* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "uiautomationcore")]
extern "system" {
    fn TextRange_FindText(
        hobj: *mut core::ffi::c_void,  // HUIATEXTRANGE
        text: *mut u16,  // LPWSTR
        backward: i32,  // BOOL
        ignoreCase: i32,  // BOOL
        pRetVal: *mut *mut core::ffi::c_void  // HUIATEXTRANGE* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("UIAutomationCore.dll")]
public static extern int TextRange_FindText(IntPtr hobj, [MarshalAs(UnmanagedType.LPWStr)] string text, bool backward, bool ignoreCase, IntPtr pRetVal);
"@
$api = Add-Type -MemberDefinition $sig -Name 'UIAutomationCore_TextRange_FindText' -Namespace Win32 -PassThru
# $api::TextRange_FindText(hobj, text, backward, ignoreCase, pRetVal)
#uselib "UIAutomationCore.dll"
#func global TextRange_FindText "TextRange_FindText" sptr, sptr, sptr, sptr, sptr
; TextRange_FindText hobj, text, backward, ignoreCase, pRetVal   ; 戻り値は stat
; hobj : HUIATEXTRANGE -> "sptr"
; text : LPWSTR -> "sptr"
; backward : BOOL -> "sptr"
; ignoreCase : BOOL -> "sptr"
; pRetVal : HUIATEXTRANGE* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "UIAutomationCore.dll"
#cfunc global TextRange_FindText "TextRange_FindText" sptr, wstr, int, int, sptr
; res = TextRange_FindText(hobj, text, backward, ignoreCase, pRetVal)
; hobj : HUIATEXTRANGE -> "sptr"
; text : LPWSTR -> "wstr"
; backward : BOOL -> "int"
; ignoreCase : BOOL -> "int"
; pRetVal : HUIATEXTRANGE* in/out -> "sptr"
; HRESULT TextRange_FindText(HUIATEXTRANGE hobj, LPWSTR text, BOOL backward, BOOL ignoreCase, HUIATEXTRANGE* pRetVal)
#uselib "UIAutomationCore.dll"
#cfunc global TextRange_FindText "TextRange_FindText" intptr, wstr, int, int, intptr
; res = TextRange_FindText(hobj, text, backward, ignoreCase, pRetVal)
; hobj : HUIATEXTRANGE -> "intptr"
; text : LPWSTR -> "wstr"
; backward : BOOL -> "int"
; ignoreCase : BOOL -> "int"
; pRetVal : HUIATEXTRANGE* in/out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	uiautomationcore = windows.NewLazySystemDLL("UIAutomationCore.dll")
	procTextRange_FindText = uiautomationcore.NewProc("TextRange_FindText")
)

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

extern "uiautomationcore" fn TextRange_FindText(
    hobj: ?*anyopaque, // HUIATEXTRANGE
    text: [*c]const u16, // LPWSTR
    backward: i32, // BOOL
    ignoreCase: i32, // BOOL
    pRetVal: ?*anyopaque // HUIATEXTRANGE* in/out
) callconv(std.os.windows.WINAPI) i32;
proc TextRange_FindText(
    hobj: pointer,  # HUIATEXTRANGE
    text: WideCString,  # LPWSTR
    backward: int32,  # BOOL
    ignoreCase: int32,  # BOOL
    pRetVal: pointer  # HUIATEXTRANGE* in/out
): int32 {.importc: "TextRange_FindText", stdcall, dynlib: "UIAutomationCore.dll".}
pragma(lib, "uiautomationcore");
extern(Windows)
int TextRange_FindText(
    void* hobj,   // HUIATEXTRANGE
    const(wchar)* text,   // LPWSTR
    int backward,   // BOOL
    int ignoreCase,   // BOOL
    void* pRetVal   // HUIATEXTRANGE* in/out
);
ccall((:TextRange_FindText, "UIAutomationCore.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cwstring, Int32, Int32, Ptr{Cvoid}),
      hobj, text, backward, ignoreCase, pRetVal)
# hobj : HUIATEXTRANGE -> Ptr{Cvoid}
# text : LPWSTR -> Cwstring
# backward : BOOL -> Int32
# ignoreCase : BOOL -> Int32
# pRetVal : HUIATEXTRANGE* in/out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t TextRange_FindText(
    void* hobj,
    const uint16_t* text,
    int32_t backward,
    int32_t ignoreCase,
    void* pRetVal);
]]
local uiautomationcore = ffi.load("uiautomationcore")
-- uiautomationcore.TextRange_FindText(hobj, text, backward, ignoreCase, pRetVal)
-- hobj : HUIATEXTRANGE
-- text : LPWSTR
-- backward : BOOL
-- ignoreCase : BOOL
-- pRetVal : HUIATEXTRANGE* in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('UIAutomationCore.dll');
const TextRange_FindText = lib.func('__stdcall', 'TextRange_FindText', 'int32_t', ['void *', 'str16', 'int32_t', 'int32_t', 'void *']);
// TextRange_FindText(hobj, text, backward, ignoreCase, pRetVal)
// hobj : HUIATEXTRANGE -> 'void *'
// text : LPWSTR -> 'str16'
// backward : BOOL -> 'int32_t'
// ignoreCase : BOOL -> 'int32_t'
// pRetVal : HUIATEXTRANGE* in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("UIAutomationCore.dll", {
  TextRange_FindText: { parameters: ["pointer", "buffer", "i32", "i32", "pointer"], result: "i32" },
});
// lib.symbols.TextRange_FindText(hobj, text, backward, ignoreCase, pRetVal)
// hobj : HUIATEXTRANGE -> "pointer"
// text : LPWSTR -> "buffer"
// backward : BOOL -> "i32"
// ignoreCase : BOOL -> "i32"
// pRetVal : HUIATEXTRANGE* in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t TextRange_FindText(
    void* hobj,
    const uint16_t* text,
    int32_t backward,
    int32_t ignoreCase,
    void* pRetVal);
C, "UIAutomationCore.dll");
// $ffi->TextRange_FindText(hobj, text, backward, ignoreCase, pRetVal);
// hobj : HUIATEXTRANGE
// text : LPWSTR
// backward : BOOL
// ignoreCase : BOOL
// pRetVal : HUIATEXTRANGE* 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_FindText(
        Pointer hobj,   // HUIATEXTRANGE
        WString text,   // LPWSTR
        boolean backward,   // BOOL
        boolean ignoreCase,   // BOOL
        Pointer pRetVal   // HUIATEXTRANGE* in/out
    );
}
@[Link("uiautomationcore")]
lib LibUIAutomationCore
  fun TextRange_FindText = TextRange_FindText(
    hobj : Void*,   # HUIATEXTRANGE
    text : UInt16*,   # LPWSTR
    backward : Int32,   # BOOL
    ignoreCase : Int32,   # BOOL
    pRetVal : Void*   # HUIATEXTRANGE* 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_FindTextNative = Int32 Function(Pointer<Void>, Pointer<Utf16>, Int32, Int32, Pointer<Void>);
typedef TextRange_FindTextDart = int Function(Pointer<Void>, Pointer<Utf16>, int, int, Pointer<Void>);
final TextRange_FindText = DynamicLibrary.open('UIAutomationCore.dll')
    .lookupFunction<TextRange_FindTextNative, TextRange_FindTextDart>('TextRange_FindText');
// hobj : HUIATEXTRANGE -> Pointer<Void>
// text : LPWSTR -> Pointer<Utf16>
// backward : BOOL -> Int32
// ignoreCase : BOOL -> Int32
// pRetVal : HUIATEXTRANGE* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function TextRange_FindText(
  hobj: THandle;   // HUIATEXTRANGE
  text: PWideChar;   // LPWSTR
  backward: BOOL;   // BOOL
  ignoreCase: BOOL;   // BOOL
  pRetVal: Pointer   // HUIATEXTRANGE* in/out
): Integer; stdcall;
  external 'UIAutomationCore.dll' name 'TextRange_FindText';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

(cffi:defcfun ("TextRange_FindText" text-range-find-text :convention :stdcall) :int32
  (hobj :pointer)   ; HUIATEXTRANGE
  (text (:string :encoding :utf-16le))   ; LPWSTR
  (backward :int32)   ; BOOL
  (ignore-case :int32)   ; BOOL
  (p-ret-val :pointer))   ; HUIATEXTRANGE* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $TextRange_FindText = Win32::API::More->new('UIAutomationCore',
    'int TextRange_FindText(HANDLE hobj, LPCWSTR text, BOOL backward, BOOL ignoreCase, HANDLE pRetVal)');
# my $ret = $TextRange_FindText->Call($hobj, $text, $backward, $ignoreCase, $pRetVal);
# hobj : HUIATEXTRANGE -> HANDLE
# text : LPWSTR -> LPCWSTR
# backward : BOOL -> BOOL
# ignoreCase : BOOL -> BOOL
# pRetVal : HUIATEXTRANGE* in/out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。