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

TextRange_CompareEndpoints

関数
二つのテキスト範囲の端点位置を比較する。
DLLUIAutomationCore.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT TextRange_CompareEndpoints(
    HUIATEXTRANGE hobj,
    TextPatternRangeEndpoint endpoint,
    HUIATEXTRANGE targetRange,
    TextPatternRangeEndpoint targetEndpoint,
    INT* pRetVal
);

パラメーター

名前方向説明
hobjHUIATEXTRANGEin比較元のテキスト範囲ハンドル。
endpointTextPatternRangeEndpointin比較に用いるこの範囲の端点(始点・終点)を示すTextPatternRangeEndpoint値。
targetRangeHUIATEXTRANGEin比較対象となるテキスト範囲ハンドル。
targetEndpointTextPatternRangeEndpointin比較に用いる対象範囲の端点を示すTextPatternRangeEndpoint値。
pRetValINT*inout端点の前後関係を示す整数を受け取る出力先(負=前、0=同位置、正=後)。

戻り値の型: HRESULT

各言語での呼び出し定義

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

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

TextRange_CompareEndpoints = ctypes.windll.uiautomationcore.TextRange_CompareEndpoints
TextRange_CompareEndpoints.restype = ctypes.c_int
TextRange_CompareEndpoints.argtypes = [
    wintypes.HANDLE,  # hobj : HUIATEXTRANGE
    ctypes.c_int,  # endpoint : TextPatternRangeEndpoint
    wintypes.HANDLE,  # targetRange : HUIATEXTRANGE
    ctypes.c_int,  # targetEndpoint : TextPatternRangeEndpoint
    ctypes.POINTER(ctypes.c_int),  # pRetVal : INT* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	uiautomationcore = windows.NewLazySystemDLL("UIAutomationCore.dll")
	procTextRange_CompareEndpoints = uiautomationcore.NewProc("TextRange_CompareEndpoints")
)

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

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

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

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

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

関連項目

使用する型