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

UiaGetPatternProvider

関数
UIオートメーションノードの指定コントロールパターンを取得する。
DLLUIAutomationCore.dll呼出規約winapi対応OSWindows XP 以降

シグネチャ

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

HRESULT UiaGetPatternProvider(
    HUIANODE hnode,
    INT patternId,
    HUIAPATTERNOBJECT* phobj
);

パラメーター

名前方向説明
hnodeHUIANODEinコントロールパターンを取得する対象ノードのハンドル。
patternIdINTin取得するパターンを識別するパターンID(UIA_*_PatternId)。
phobjHUIAPATTERNOBJECT*inout取得したパターンオブジェクトハンドルを受け取る出力先。未対応時はNULLが返る。

戻り値の型: HRESULT

各言語での呼び出し定義

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

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

UiaGetPatternProvider = ctypes.windll.uiautomationcore.UiaGetPatternProvider
UiaGetPatternProvider.restype = ctypes.c_int
UiaGetPatternProvider.argtypes = [
    wintypes.HANDLE,  # hnode : HUIANODE
    ctypes.c_int,  # patternId : INT
    ctypes.c_void_p,  # phobj : HUIAPATTERNOBJECT* in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('UIAutomationCore.dll')
UiaGetPatternProvider = Fiddle::Function.new(
  lib['UiaGetPatternProvider'],
  [
    Fiddle::TYPE_VOIDP,  # hnode : HUIANODE
    Fiddle::TYPE_INT,  # patternId : INT
    Fiddle::TYPE_VOIDP,  # phobj : HUIAPATTERNOBJECT* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "uiautomationcore")]
extern "system" {
    fn UiaGetPatternProvider(
        hnode: *mut core::ffi::c_void,  // HUIANODE
        patternId: i32,  // INT
        phobj: *mut *mut core::ffi::c_void  // HUIAPATTERNOBJECT* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("UIAutomationCore.dll")]
public static extern int UiaGetPatternProvider(IntPtr hnode, int patternId, IntPtr phobj);
"@
$api = Add-Type -MemberDefinition $sig -Name 'UIAutomationCore_UiaGetPatternProvider' -Namespace Win32 -PassThru
# $api::UiaGetPatternProvider(hnode, patternId, phobj)
#uselib "UIAutomationCore.dll"
#func global UiaGetPatternProvider "UiaGetPatternProvider" sptr, sptr, sptr
; UiaGetPatternProvider hnode, patternId, phobj   ; 戻り値は stat
; hnode : HUIANODE -> "sptr"
; patternId : INT -> "sptr"
; phobj : HUIAPATTERNOBJECT* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "UIAutomationCore.dll"
#cfunc global UiaGetPatternProvider "UiaGetPatternProvider" sptr, int, sptr
; res = UiaGetPatternProvider(hnode, patternId, phobj)
; hnode : HUIANODE -> "sptr"
; patternId : INT -> "int"
; phobj : HUIAPATTERNOBJECT* in/out -> "sptr"
; HRESULT UiaGetPatternProvider(HUIANODE hnode, INT patternId, HUIAPATTERNOBJECT* phobj)
#uselib "UIAutomationCore.dll"
#cfunc global UiaGetPatternProvider "UiaGetPatternProvider" intptr, int, intptr
; res = UiaGetPatternProvider(hnode, patternId, phobj)
; hnode : HUIANODE -> "intptr"
; patternId : INT -> "int"
; phobj : HUIAPATTERNOBJECT* in/out -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	uiautomationcore = windows.NewLazySystemDLL("UIAutomationCore.dll")
	procUiaGetPatternProvider = uiautomationcore.NewProc("UiaGetPatternProvider")
)

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

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

foreign import stdcall safe "UiaGetPatternProvider"
  c_UiaGetPatternProvider :: Ptr () -> Int32 -> Ptr () -> IO Int32
-- hnode : HUIANODE -> Ptr ()
-- patternId : INT -> Int32
-- phobj : HUIAPATTERNOBJECT* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let uiagetpatternprovider =
  foreign "UiaGetPatternProvider"
    ((ptr void) @-> int32_t @-> (ptr void) @-> returning int32_t)
(* hnode : HUIANODE -> (ptr void) *)
(* patternId : INT -> int32_t *)
(* phobj : HUIAPATTERNOBJECT* 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 ("UiaGetPatternProvider" uia-get-pattern-provider :convention :stdcall) :int32
  (hnode :pointer)   ; HUIANODE
  (pattern-id :int32)   ; INT
  (phobj :pointer))   ; HUIAPATTERNOBJECT* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $UiaGetPatternProvider = Win32::API::More->new('UIAutomationCore',
    'int UiaGetPatternProvider(HANDLE hnode, int patternId, HANDLE phobj)');
# my $ret = $UiaGetPatternProvider->Call($hnode, $patternId, $phobj);
# hnode : HUIANODE -> HANDLE
# patternId : INT -> int
# phobj : HUIAPATTERNOBJECT* in/out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。