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

UiaFind

関数
条件に一致するUIオートメーション要素をツリーから検索する。
DLLUIAutomationCore.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT UiaFind(
    HUIANODE hnode,
    UiaFindParams* pParams,
    UiaCacheRequest* pRequest,
    SAFEARRAY** ppRequestedData,
    SAFEARRAY** ppOffsets,
    SAFEARRAY** ppTreeStructures
);

パラメーター

名前方向説明
hnodeHUIANODEin検索の起点(ルート)となるノードのハンドル。
pParamsUiaFindParams*inout検索条件・スコープ・検索方向などを指定するUiaFindParams。
pRequestUiaCacheRequest*inout見つかった要素から取得するプロパティやパターンを指定するキャッシュ要求。
ppRequestedDataSAFEARRAY**inout条件に一致した各要素の取得データを格納したSAFEARRAYを受け取る出力先。
ppOffsetsSAFEARRAY**inout各一致要素の階層オフセットを格納したSAFEARRAYを受け取る出力先。
ppTreeStructuresSAFEARRAY**inout各一致要素のツリー構造記述を格納したSAFEARRAYを受け取る出力先。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT UiaFind(
    HUIANODE hnode,
    UiaFindParams* pParams,
    UiaCacheRequest* pRequest,
    SAFEARRAY** ppRequestedData,
    SAFEARRAY** ppOffsets,
    SAFEARRAY** ppTreeStructures
);
[DllImport("UIAutomationCore.dll", ExactSpelling = true)]
static extern int UiaFind(
    IntPtr hnode,   // HUIANODE
    IntPtr pParams,   // UiaFindParams* in/out
    IntPtr pRequest,   // UiaCacheRequest* in/out
    IntPtr ppRequestedData,   // SAFEARRAY** in/out
    IntPtr ppOffsets,   // SAFEARRAY** in/out
    IntPtr ppTreeStructures   // SAFEARRAY** in/out
);
<DllImport("UIAutomationCore.dll", ExactSpelling:=True)>
Public Shared Function UiaFind(
    hnode As IntPtr,   ' HUIANODE
    pParams As IntPtr,   ' UiaFindParams* in/out
    pRequest As IntPtr,   ' UiaCacheRequest* in/out
    ppRequestedData As IntPtr,   ' SAFEARRAY** in/out
    ppOffsets As IntPtr,   ' SAFEARRAY** in/out
    ppTreeStructures As IntPtr   ' SAFEARRAY** in/out
) As Integer
End Function
' hnode : HUIANODE
' pParams : UiaFindParams* in/out
' pRequest : UiaCacheRequest* in/out
' ppRequestedData : SAFEARRAY** in/out
' ppOffsets : SAFEARRAY** in/out
' ppTreeStructures : SAFEARRAY** in/out
Declare PtrSafe Function UiaFind Lib "uiautomationcore" ( _
    ByVal hnode As LongPtr, _
    ByVal pParams As LongPtr, _
    ByVal pRequest As LongPtr, _
    ByVal ppRequestedData As LongPtr, _
    ByVal ppOffsets As LongPtr, _
    ByVal ppTreeStructures As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

UiaFind = ctypes.windll.uiautomationcore.UiaFind
UiaFind.restype = ctypes.c_int
UiaFind.argtypes = [
    wintypes.HANDLE,  # hnode : HUIANODE
    ctypes.c_void_p,  # pParams : UiaFindParams* in/out
    ctypes.c_void_p,  # pRequest : UiaCacheRequest* in/out
    ctypes.c_void_p,  # ppRequestedData : SAFEARRAY** in/out
    ctypes.c_void_p,  # ppOffsets : SAFEARRAY** in/out
    ctypes.c_void_p,  # ppTreeStructures : SAFEARRAY** in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	uiautomationcore = windows.NewLazySystemDLL("UIAutomationCore.dll")
	procUiaFind = uiautomationcore.NewProc("UiaFind")
)

// hnode (HUIANODE), pParams (UiaFindParams* in/out), pRequest (UiaCacheRequest* in/out), ppRequestedData (SAFEARRAY** in/out), ppOffsets (SAFEARRAY** in/out), ppTreeStructures (SAFEARRAY** in/out)
r1, _, err := procUiaFind.Call(
	uintptr(hnode),
	uintptr(pParams),
	uintptr(pRequest),
	uintptr(ppRequestedData),
	uintptr(ppOffsets),
	uintptr(ppTreeStructures),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function UiaFind(
  hnode: THandle;   // HUIANODE
  pParams: Pointer;   // UiaFindParams* in/out
  pRequest: Pointer;   // UiaCacheRequest* in/out
  ppRequestedData: Pointer;   // SAFEARRAY** in/out
  ppOffsets: Pointer;   // SAFEARRAY** in/out
  ppTreeStructures: Pointer   // SAFEARRAY** in/out
): Integer; stdcall;
  external 'UIAutomationCore.dll' name 'UiaFind';
result := DllCall("UIAutomationCore\UiaFind"
    , "Ptr", hnode   ; HUIANODE
    , "Ptr", pParams   ; UiaFindParams* in/out
    , "Ptr", pRequest   ; UiaCacheRequest* in/out
    , "Ptr", ppRequestedData   ; SAFEARRAY** in/out
    , "Ptr", ppOffsets   ; SAFEARRAY** in/out
    , "Ptr", ppTreeStructures   ; SAFEARRAY** in/out
    , "Int")   ; return: HRESULT
●UiaFind(hnode, pParams, pRequest, ppRequestedData, ppOffsets, ppTreeStructures) = DLL("UIAutomationCore.dll", "int UiaFind(void*, void*, void*, void*, void*, void*)")
# 呼び出し: UiaFind(hnode, pParams, pRequest, ppRequestedData, ppOffsets, ppTreeStructures)
# hnode : HUIANODE -> "void*"
# pParams : UiaFindParams* in/out -> "void*"
# pRequest : UiaCacheRequest* in/out -> "void*"
# ppRequestedData : SAFEARRAY** in/out -> "void*"
# ppOffsets : SAFEARRAY** in/out -> "void*"
# ppTreeStructures : SAFEARRAY** in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

foreign import stdcall safe "UiaFind"
  c_UiaFind :: Ptr () -> Ptr () -> Ptr () -> Ptr () -> Ptr () -> Ptr () -> IO Int32
-- hnode : HUIANODE -> Ptr ()
-- pParams : UiaFindParams* in/out -> Ptr ()
-- pRequest : UiaCacheRequest* in/out -> Ptr ()
-- ppRequestedData : SAFEARRAY** in/out -> Ptr ()
-- ppOffsets : SAFEARRAY** in/out -> Ptr ()
-- ppTreeStructures : SAFEARRAY** in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let uiafind =
  foreign "UiaFind"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* hnode : HUIANODE -> (ptr void) *)
(* pParams : UiaFindParams* in/out -> (ptr void) *)
(* pRequest : UiaCacheRequest* in/out -> (ptr void) *)
(* ppRequestedData : SAFEARRAY** in/out -> (ptr void) *)
(* ppOffsets : SAFEARRAY** in/out -> (ptr void) *)
(* ppTreeStructures : SAFEARRAY** 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 ("UiaFind" uia-find :convention :stdcall) :int32
  (hnode :pointer)   ; HUIANODE
  (p-params :pointer)   ; UiaFindParams* in/out
  (p-request :pointer)   ; UiaCacheRequest* in/out
  (pp-requested-data :pointer)   ; SAFEARRAY** in/out
  (pp-offsets :pointer)   ; SAFEARRAY** in/out
  (pp-tree-structures :pointer))   ; SAFEARRAY** in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $UiaFind = Win32::API::More->new('UIAutomationCore',
    'int UiaFind(HANDLE hnode, LPVOID pParams, LPVOID pRequest, LPVOID ppRequestedData, LPVOID ppOffsets, LPVOID ppTreeStructures)');
# my $ret = $UiaFind->Call($hnode, $pParams, $pRequest, $ppRequestedData, $ppOffsets, $ppTreeStructures);
# hnode : HUIANODE -> HANDLE
# pParams : UiaFindParams* in/out -> LPVOID
# pRequest : UiaCacheRequest* in/out -> LPVOID
# ppRequestedData : SAFEARRAY** in/out -> LPVOID
# ppOffsets : SAFEARRAY** in/out -> LPVOID
# ppTreeStructures : SAFEARRAY** in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型