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

UiaNavigate

関数
指定方向へUIオートメーションツリーをたどり要素を取得する。
DLLUIAutomationCore.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT UiaNavigate(
    HUIANODE hnode,
    NavigateDirection direction,
    UiaCondition* pCondition,
    UiaCacheRequest* pRequest,
    SAFEARRAY** ppRequestedData,
    LPWSTR* ppTreeStructure
);

パラメーター

名前方向説明
hnodeHUIANODEinナビゲーションの起点となるノードのハンドル。
directionNavigateDirectionin移動方向(親・次の兄弟・最初の子など)を示すNavigateDirection値。
pConditionUiaCondition*inout移動先ノードが満たすべき条件を指定するUiaCondition。ビューのフィルタリングに用いる。
pRequestUiaCacheRequest*inout取得するプロパティやパターンを指定するキャッシュ要求。
ppRequestedDataSAFEARRAY**inoutキャッシュ要求に従い取得したデータを格納したSAFEARRAYを受け取る出力先。
ppTreeStructureLPWSTR*inout返されたノードのツリー構造を記述する文字列を受け取る出力先。

戻り値の型: HRESULT

各言語での呼び出し定義

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

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

UiaNavigate = ctypes.windll.uiautomationcore.UiaNavigate
UiaNavigate.restype = ctypes.c_int
UiaNavigate.argtypes = [
    wintypes.HANDLE,  # hnode : HUIANODE
    ctypes.c_int,  # direction : NavigateDirection
    ctypes.c_void_p,  # pCondition : UiaCondition* in/out
    ctypes.c_void_p,  # pRequest : UiaCacheRequest* in/out
    ctypes.c_void_p,  # ppRequestedData : SAFEARRAY** in/out
    ctypes.c_void_p,  # ppTreeStructure : LPWSTR* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('UIAutomationCore.dll')
UiaNavigate = Fiddle::Function.new(
  lib['UiaNavigate'],
  [
    Fiddle::TYPE_VOIDP,  # hnode : HUIANODE
    Fiddle::TYPE_INT,  # direction : NavigateDirection
    Fiddle::TYPE_VOIDP,  # pCondition : UiaCondition* in/out
    Fiddle::TYPE_VOIDP,  # pRequest : UiaCacheRequest* in/out
    Fiddle::TYPE_VOIDP,  # ppRequestedData : SAFEARRAY** in/out
    Fiddle::TYPE_VOIDP,  # ppTreeStructure : LPWSTR* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "uiautomationcore")]
extern "system" {
    fn UiaNavigate(
        hnode: *mut core::ffi::c_void,  // HUIANODE
        direction: i32,  // NavigateDirection
        pCondition: *mut UiaCondition,  // UiaCondition* in/out
        pRequest: *mut UiaCacheRequest,  // UiaCacheRequest* in/out
        ppRequestedData: *mut *mut SAFEARRAY,  // SAFEARRAY** in/out
        ppTreeStructure: *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 UiaNavigate(IntPtr hnode, int direction, IntPtr pCondition, IntPtr pRequest, IntPtr ppRequestedData, IntPtr ppTreeStructure);
"@
$api = Add-Type -MemberDefinition $sig -Name 'UIAutomationCore_UiaNavigate' -Namespace Win32 -PassThru
# $api::UiaNavigate(hnode, direction, pCondition, pRequest, ppRequestedData, ppTreeStructure)
#uselib "UIAutomationCore.dll"
#func global UiaNavigate "UiaNavigate" sptr, sptr, sptr, sptr, sptr, sptr
; UiaNavigate hnode, direction, varptr(pCondition), varptr(pRequest), varptr(ppRequestedData), varptr(ppTreeStructure)   ; 戻り値は stat
; hnode : HUIANODE -> "sptr"
; direction : NavigateDirection -> "sptr"
; pCondition : UiaCondition* in/out -> "sptr"
; pRequest : UiaCacheRequest* in/out -> "sptr"
; ppRequestedData : SAFEARRAY** in/out -> "sptr"
; ppTreeStructure : LPWSTR* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "UIAutomationCore.dll"
#cfunc global UiaNavigate "UiaNavigate" sptr, int, var, var, var, var
; res = UiaNavigate(hnode, direction, pCondition, pRequest, ppRequestedData, ppTreeStructure)
; hnode : HUIANODE -> "sptr"
; direction : NavigateDirection -> "int"
; pCondition : UiaCondition* in/out -> "var"
; pRequest : UiaCacheRequest* in/out -> "var"
; ppRequestedData : SAFEARRAY** in/out -> "var"
; ppTreeStructure : LPWSTR* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT UiaNavigate(HUIANODE hnode, NavigateDirection direction, UiaCondition* pCondition, UiaCacheRequest* pRequest, SAFEARRAY** ppRequestedData, LPWSTR* ppTreeStructure)
#uselib "UIAutomationCore.dll"
#cfunc global UiaNavigate "UiaNavigate" intptr, int, var, var, var, var
; res = UiaNavigate(hnode, direction, pCondition, pRequest, ppRequestedData, ppTreeStructure)
; hnode : HUIANODE -> "intptr"
; direction : NavigateDirection -> "int"
; pCondition : UiaCondition* in/out -> "var"
; pRequest : UiaCacheRequest* in/out -> "var"
; ppRequestedData : SAFEARRAY** in/out -> "var"
; ppTreeStructure : LPWSTR* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	uiautomationcore = windows.NewLazySystemDLL("UIAutomationCore.dll")
	procUiaNavigate = uiautomationcore.NewProc("UiaNavigate")
)

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

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

foreign import stdcall safe "UiaNavigate"
  c_UiaNavigate :: Ptr () -> Int32 -> Ptr () -> Ptr () -> Ptr () -> Ptr CWString -> IO Int32
-- hnode : HUIANODE -> Ptr ()
-- direction : NavigateDirection -> Int32
-- pCondition : UiaCondition* in/out -> Ptr ()
-- pRequest : UiaCacheRequest* in/out -> Ptr ()
-- ppRequestedData : SAFEARRAY** in/out -> Ptr ()
-- ppTreeStructure : LPWSTR* in/out -> Ptr CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

関連項目

使用する型