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

UiaNodeFromFocus

関数
現在フォーカスを持つUIオートメーションノードを取得する。
DLLUIAutomationCore.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT UiaNodeFromFocus(
    UiaCacheRequest* pRequest,
    SAFEARRAY** ppRequestedData,
    LPWSTR* ppTreeStructure
);

パラメーター

名前方向説明
pRequestUiaCacheRequest*inout取得するプロパティやパターンを指定するキャッシュ要求。
ppRequestedDataSAFEARRAY**inout現在フォーカスを持つ要素の取得データを格納したSAFEARRAYを受け取る出力先。
ppTreeStructureLPWSTR*inout返されたノードのツリー構造を記述する文字列を受け取る出力先。

戻り値の型: HRESULT

各言語での呼び出し定義

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

HRESULT UiaNodeFromFocus(
    UiaCacheRequest* pRequest,
    SAFEARRAY** ppRequestedData,
    LPWSTR* ppTreeStructure
);
[DllImport("UIAutomationCore.dll", ExactSpelling = true)]
static extern int UiaNodeFromFocus(
    IntPtr pRequest,   // UiaCacheRequest* in/out
    IntPtr ppRequestedData,   // SAFEARRAY** in/out
    IntPtr ppTreeStructure   // LPWSTR* in/out
);
<DllImport("UIAutomationCore.dll", ExactSpelling:=True)>
Public Shared Function UiaNodeFromFocus(
    pRequest As IntPtr,   ' UiaCacheRequest* in/out
    ppRequestedData As IntPtr,   ' SAFEARRAY** in/out
    ppTreeStructure As IntPtr   ' LPWSTR* in/out
) As Integer
End Function
' pRequest : UiaCacheRequest* in/out
' ppRequestedData : SAFEARRAY** in/out
' ppTreeStructure : LPWSTR* in/out
Declare PtrSafe Function UiaNodeFromFocus Lib "uiautomationcore" ( _
    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

UiaNodeFromFocus = ctypes.windll.uiautomationcore.UiaNodeFromFocus
UiaNodeFromFocus.restype = ctypes.c_int
UiaNodeFromFocus.argtypes = [
    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')
UiaNodeFromFocus = Fiddle::Function.new(
  lib['UiaNodeFromFocus'],
  [
    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 UiaNodeFromFocus(
        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 UiaNodeFromFocus(IntPtr pRequest, IntPtr ppRequestedData, IntPtr ppTreeStructure);
"@
$api = Add-Type -MemberDefinition $sig -Name 'UIAutomationCore_UiaNodeFromFocus' -Namespace Win32 -PassThru
# $api::UiaNodeFromFocus(pRequest, ppRequestedData, ppTreeStructure)
#uselib "UIAutomationCore.dll"
#func global UiaNodeFromFocus "UiaNodeFromFocus" sptr, sptr, sptr
; UiaNodeFromFocus varptr(pRequest), varptr(ppRequestedData), varptr(ppTreeStructure)   ; 戻り値は stat
; pRequest : UiaCacheRequest* in/out -> "sptr"
; ppRequestedData : SAFEARRAY** in/out -> "sptr"
; ppTreeStructure : LPWSTR* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "UIAutomationCore.dll"
#cfunc global UiaNodeFromFocus "UiaNodeFromFocus" var, var, var
; res = UiaNodeFromFocus(pRequest, ppRequestedData, ppTreeStructure)
; pRequest : UiaCacheRequest* in/out -> "var"
; ppRequestedData : SAFEARRAY** in/out -> "var"
; ppTreeStructure : LPWSTR* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT UiaNodeFromFocus(UiaCacheRequest* pRequest, SAFEARRAY** ppRequestedData, LPWSTR* ppTreeStructure)
#uselib "UIAutomationCore.dll"
#cfunc global UiaNodeFromFocus "UiaNodeFromFocus" var, var, var
; res = UiaNodeFromFocus(pRequest, ppRequestedData, ppTreeStructure)
; 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")
	procUiaNodeFromFocus = uiautomationcore.NewProc("UiaNodeFromFocus")
)

// pRequest (UiaCacheRequest* in/out), ppRequestedData (SAFEARRAY** in/out), ppTreeStructure (LPWSTR* in/out)
r1, _, err := procUiaNodeFromFocus.Call(
	uintptr(pRequest),
	uintptr(ppRequestedData),
	uintptr(ppTreeStructure),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function UiaNodeFromFocus(
  pRequest: Pointer;   // UiaCacheRequest* in/out
  ppRequestedData: Pointer;   // SAFEARRAY** in/out
  ppTreeStructure: PPWideChar   // LPWSTR* in/out
): Integer; stdcall;
  external 'UIAutomationCore.dll' name 'UiaNodeFromFocus';
result := DllCall("UIAutomationCore\UiaNodeFromFocus"
    , "Ptr", pRequest   ; UiaCacheRequest* in/out
    , "Ptr", ppRequestedData   ; SAFEARRAY** in/out
    , "Ptr", ppTreeStructure   ; LPWSTR* in/out
    , "Int")   ; return: HRESULT
●UiaNodeFromFocus(pRequest, ppRequestedData, ppTreeStructure) = DLL("UIAutomationCore.dll", "int UiaNodeFromFocus(void*, void*, void*)")
# 呼び出し: UiaNodeFromFocus(pRequest, ppRequestedData, ppTreeStructure)
# 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 UiaNodeFromFocus(
    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 UiaNodeFromFocus(
    pRequest: ptr UiaCacheRequest,  # UiaCacheRequest* in/out
    ppRequestedData: ptr SAFEARRAY,  # SAFEARRAY** in/out
    ppTreeStructure: ptr WideCString  # LPWSTR* in/out
): int32 {.importc: "UiaNodeFromFocus", stdcall, dynlib: "UIAutomationCore.dll".}
pragma(lib, "uiautomationcore");
extern(Windows)
int UiaNodeFromFocus(
    UiaCacheRequest* pRequest,   // UiaCacheRequest* in/out
    SAFEARRAY** ppRequestedData,   // SAFEARRAY** in/out
    wchar** ppTreeStructure   // LPWSTR* in/out
);
ccall((:UiaNodeFromFocus, "UIAutomationCore.dll"), stdcall, Int32,
      (Ptr{UiaCacheRequest}, Ptr{SAFEARRAY}, Ptr{Ptr{UInt16}}),
      pRequest, ppRequestedData, ppTreeStructure)
# 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 UiaNodeFromFocus(
    void* pRequest,
    void* ppRequestedData,
    uint16_t** ppTreeStructure);
]]
local uiautomationcore = ffi.load("uiautomationcore")
-- uiautomationcore.UiaNodeFromFocus(pRequest, ppRequestedData, ppTreeStructure)
-- 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 UiaNodeFromFocus = lib.func('__stdcall', 'UiaNodeFromFocus', 'int32_t', ['void *', 'void *', 'void *']);
// UiaNodeFromFocus(pRequest, ppRequestedData, ppTreeStructure)
// 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", {
  UiaNodeFromFocus: { parameters: ["pointer", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.UiaNodeFromFocus(pRequest, ppRequestedData, ppTreeStructure)
// 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 UiaNodeFromFocus(
    void* pRequest,
    void* ppRequestedData,
    uint16_t** ppTreeStructure);
C, "UIAutomationCore.dll");
// $ffi->UiaNodeFromFocus(pRequest, ppRequestedData, ppTreeStructure);
// 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 UiaNodeFromFocus(
        Pointer pRequest,   // UiaCacheRequest* in/out
        Pointer ppRequestedData,   // SAFEARRAY** in/out
        PointerByReference ppTreeStructure   // LPWSTR* in/out
    );
}
@[Link("uiautomationcore")]
lib LibUIAutomationCore
  fun UiaNodeFromFocus = UiaNodeFromFocus(
    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 UiaNodeFromFocusNative = Int32 Function(Pointer<Void>, Pointer<Void>, Pointer<Pointer<Utf16>>);
typedef UiaNodeFromFocusDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Pointer<Utf16>>);
final UiaNodeFromFocus = DynamicLibrary.open('UIAutomationCore.dll')
    .lookupFunction<UiaNodeFromFocusNative, UiaNodeFromFocusDart>('UiaNodeFromFocus');
// 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 UiaNodeFromFocus(
  pRequest: Pointer;   // UiaCacheRequest* in/out
  ppRequestedData: Pointer;   // SAFEARRAY** in/out
  ppTreeStructure: PPWideChar   // LPWSTR* in/out
): Integer; stdcall;
  external 'UIAutomationCore.dll' name 'UiaNodeFromFocus';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "UiaNodeFromFocus"
  c_UiaNodeFromFocus :: Ptr () -> Ptr () -> Ptr CWString -> IO Int32
-- 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 uianodefromfocus =
  foreign "UiaNodeFromFocus"
    ((ptr void) @-> (ptr void) @-> (ptr (ptr uint16_t)) @-> returning int32_t)
(* 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 ("UiaNodeFromFocus" uia-node-from-focus :convention :stdcall) :int32
  (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 $UiaNodeFromFocus = Win32::API::More->new('UIAutomationCore',
    'int UiaNodeFromFocus(LPVOID pRequest, LPVOID ppRequestedData, LPVOID ppTreeStructure)');
# my $ret = $UiaNodeFromFocus->Call($pRequest, $ppRequestedData, $ppTreeStructure);
# pRequest : UiaCacheRequest* in/out -> LPVOID
# ppRequestedData : SAFEARRAY** in/out -> LPVOID
# ppTreeStructure : LPWSTR* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型