ホーム › UI.Accessibility › AccessibleObjectFromEvent

AccessibleObjectFromEvent

関数

WinEventの発生元からアクセシブルオブジェクトを取得する。

DLLOLEACC.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

HRESULT AccessibleObjectFromEvent(
    HWND hwnd,
    DWORD dwId,
    DWORD dwChildId,
    IAccessible** ppacc,
    VARIANT* pvarChild
);

パラメーター

名前	型	方向	説明
hwnd	HWND	in	イベントを生成したウィンドウのウィンドウハンドルを指定します。この値は、イベントフック関数に渡されたウィンドウハンドルでなければなりません。
dwId	DWORD	in	イベントを生成したオブジェクトのオブジェクト ID を指定します。この値は、イベントフック関数に渡されたオブジェクト ID でなければなりません。
dwChildId	DWORD	in	イベントがオブジェクトによって発生したか、その子要素の 1 つによって発生したかを指定します。オブジェクトがイベントを発生させた場合、dwChildID は CHILDID_SELF になります。子要素がイベントを発生させた場合、dwChildID はその要素の子 ID になります。この値は、イベントフック関数に渡された子 ID でなければなりません。
ppacc	IAccessible**	out	IAccessible インターフェイスのアドレスを受け取るポインター変数のアドレスです。このインターフェイスは、イベントを生成したオブジェクトのもの、またはイベントを生成した要素の親のもののいずれかです。
pvarChild	VARIANT*	out	UI 要素に関する情報へアクセスするために使用できる子 ID を格納する、VARIANT 構造体のアドレスです。

戻り値の型: HRESULT

公式ドキュメント

クライアントのイベントフック関数が現在処理しているイベントを生成したオブジェクトの、IAccessible インターフェイスのアドレスを取得します。

戻り値

型: STDAPI

成功した場合は S_OK を返します。

失敗した場合は、次のいずれか、またはその他の標準的な COM エラーコードを返します。

戻り値	説明
E_INVALIDARG	引数が無効です。

解説(Remarks)

クライアントは、イベントを生成したオブジェクト、またはイベントを生成した要素の親に対する IAccessible インターフェイスポインターを取得するために、イベントフック関数の中でこの関数を呼び出します。この関数の hwnd、dwObjectID、dwChildID の各パラメーターには、WinEventProc コールバック関数に渡されたパラメーターを使用する必要があります。

この関数は、イベントに関連付けられたオブジェクト階層の中で最下位のアクセシビリティオブジェクトを取得します。イベントを生成した要素がアクセシビリティオブジェクトでない場合 (つまり IAccessible をサポートしていない場合)、この関数は親オブジェクトの IAccessible インターフェイスを取得します。親オブジェクトは、IAccessible インターフェイスを通じて子要素に関する情報を提供しなければなりません。

他の IAccessible のメソッドや関数と同様に、ユーザーの操作が原因で、クライアントが IAccessible インターフェイスポインターに対するエラーを受け取ることがあります。詳細については、「IAccessible インターフェイスポインターに対するエラーの受信」を参照してください。

オブジェクトが完全には初期化されていないため、EVENT_OBJECT_CREATE に応答してこの関数を呼び出すと失敗します。同様に、オブジェクトはすでに利用できず応答できないため、クライアントは EVENT_OBJECT_DESTROY に応答してこの関数を呼び出すべきではありません。クライアントは、EVENT_OBJECT_CREATE や EVENT_OBJECT_DESTROY ではなく、EVENT_OBJECT_SHOW と EVENT_OBJECT_HIDE のイベントを監視します。

例

次のサンプルコードは、このメソッドを WinEventProc イベントハンドラーの中で呼び出す例を示しています。


void CALLBACK HandleWinEvent(HWINEVENTHOOK hook, DWORD event, HWND hwnd, 
                             LONG idObject, LONG idChild, 
                             DWORD dwEventThread, DWORD dwmsEventTime)
{
    IAccessible* pAcc = NULL;
    VARIANT varChild;
    HRESULT hr = AccessibleObjectFromEvent(hwnd, idObject, idChild, &pAcc, &varChild);  
    if ((hr == S_OK) && (pAcc != NULL))
    {
        // アクセシビリティオブジェクトに対して処理を行い、その後解放する。        
        // ... 
        pAcc->Release();
    }
}

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

HRESULT AccessibleObjectFromEvent(
    HWND hwnd,
    DWORD dwId,
    DWORD dwChildId,
    IAccessible** ppacc,
    VARIANT* pvarChild
);

[DllImport("OLEACC.dll", ExactSpelling = true)]
static extern int AccessibleObjectFromEvent(
    IntPtr hwnd,   // HWND
    uint dwId,   // DWORD
    uint dwChildId,   // DWORD
    IntPtr ppacc,   // IAccessible** out
    IntPtr pvarChild   // VARIANT* out
);

<DllImport("OLEACC.dll", ExactSpelling:=True)>
Public Shared Function AccessibleObjectFromEvent(
    hwnd As IntPtr,   ' HWND
    dwId As UInteger,   ' DWORD
    dwChildId As UInteger,   ' DWORD
    ppacc As IntPtr,   ' IAccessible** out
    pvarChild As IntPtr   ' VARIANT* out
) As Integer
End Function

' hwnd : HWND
' dwId : DWORD
' dwChildId : DWORD
' ppacc : IAccessible** out
' pvarChild : VARIANT* out
Declare PtrSafe Function AccessibleObjectFromEvent Lib "oleacc" ( _
    ByVal hwnd As LongPtr, _
    ByVal dwId As Long, _
    ByVal dwChildId As Long, _
    ByVal ppacc As LongPtr, _
    ByVal pvarChild As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

AccessibleObjectFromEvent = ctypes.windll.oleacc.AccessibleObjectFromEvent
AccessibleObjectFromEvent.restype = ctypes.c_int
AccessibleObjectFromEvent.argtypes = [
    wintypes.HANDLE,  # hwnd : HWND
    wintypes.DWORD,  # dwId : DWORD
    wintypes.DWORD,  # dwChildId : DWORD
    ctypes.c_void_p,  # ppacc : IAccessible** out
    ctypes.c_void_p,  # pvarChild : VARIANT* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('OLEACC.dll')
AccessibleObjectFromEvent = Fiddle::Function.new(
  lib['AccessibleObjectFromEvent'],
  [
    Fiddle::TYPE_VOIDP,  # hwnd : HWND
    -Fiddle::TYPE_INT,  # dwId : DWORD
    -Fiddle::TYPE_INT,  # dwChildId : DWORD
    Fiddle::TYPE_VOIDP,  # ppacc : IAccessible** out
    Fiddle::TYPE_VOIDP,  # pvarChild : VARIANT* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "oleacc")]
extern "system" {
    fn AccessibleObjectFromEvent(
        hwnd: *mut core::ffi::c_void,  // HWND
        dwId: u32,  // DWORD
        dwChildId: u32,  // DWORD
        ppacc: *mut *mut core::ffi::c_void,  // IAccessible** out
        pvarChild: *mut VARIANT  // VARIANT* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("OLEACC.dll")]
public static extern int AccessibleObjectFromEvent(IntPtr hwnd, uint dwId, uint dwChildId, IntPtr ppacc, IntPtr pvarChild);
"@
$api = Add-Type -MemberDefinition $sig -Name 'OLEACC_AccessibleObjectFromEvent' -Namespace Win32 -PassThru
# $api::AccessibleObjectFromEvent(hwnd, dwId, dwChildId, ppacc, pvarChild)

#uselib "OLEACC.dll"
#func global AccessibleObjectFromEvent "AccessibleObjectFromEvent" sptr, sptr, sptr, sptr, sptr
; AccessibleObjectFromEvent hwnd, dwId, dwChildId, ppacc, varptr(pvarChild)   ; 戻り値は stat
; hwnd : HWND -> "sptr"
; dwId : DWORD -> "sptr"
; dwChildId : DWORD -> "sptr"
; ppacc : IAccessible** out -> "sptr"
; pvarChild : VARIANT* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "OLEACC.dll"
#cfunc global AccessibleObjectFromEvent "AccessibleObjectFromEvent" sptr, int, int, sptr, var
; res = AccessibleObjectFromEvent(hwnd, dwId, dwChildId, ppacc, pvarChild)
; hwnd : HWND -> "sptr"
; dwId : DWORD -> "int"
; dwChildId : DWORD -> "int"
; ppacc : IAccessible** out -> "sptr"
; pvarChild : VARIANT* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "OLEACC.dll"
#cfunc global AccessibleObjectFromEvent "AccessibleObjectFromEvent" sptr, int, int, sptr, sptr
; res = AccessibleObjectFromEvent(hwnd, dwId, dwChildId, ppacc, varptr(pvarChild))
; hwnd : HWND -> "sptr"
; dwId : DWORD -> "int"
; dwChildId : DWORD -> "int"
; ppacc : IAccessible** out -> "sptr"
; pvarChild : VARIANT* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。