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
pConditionUiaCondition*inout
pRequestUiaCacheRequest*inout
ppRequestedDataSAFEARRAY**inout
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)。