AccessibleObjectFromEvent 関数 (oleacc.h)

[アーティクル]
08/25/2023

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

構文

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

パラメーター

[in] hwnd

種類: HWND

イベントを生成したウィンドウのウィンドウハンドルを指定します。この値は、イベントフック関数に送信されるウィンドウハンドルである必要があります。

[in] dwId

型: DWORD

イベントを生成したオブジェクトのオブジェクト ID を指定します。この値は、イベントフック関数に送信されるオブジェクト ID である必要があります。

[in] dwChildId

型: DWORD

イベントがオブジェクトまたはその子要素のいずれかによってトリガーされたかどうかを指定します。オブジェクトがイベントをトリガーした場合、 dwChildID はCHILDID_SELF。子要素がイベントをトリガーした場合、 dwChildID は要素の子 ID です。この値は、イベントフック関数に送信される子 ID である必要があります。

[out] ppacc

種類: IAccessible**

IAccessible インターフェイスのアドレスを受け取るポインター変数のアドレス。インターフェイスは、イベントを生成したオブジェクト、またはイベントを生成した要素の親用です。

[out] pvarChild

型: VARIANT*

UI 要素に関する情報にアクセスするために使用できる子 ID を指定する VARIANT 構造体のアドレス。

戻り値

型: STDAPI

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

成功しなかった場合は、次のいずれかの標準 COM エラーコードを返します。

リターンコード	説明
E_INVALIDARG	引数が有効ではありません。

注釈

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

この関数は、イベントに関連付けられているオブジェクト階層内の最下位レベルのアクセス可能なオブジェクトを取得します。イベントを生成した要素がアクセス可能なオブジェクトではない (つまり、 IAccessible をサポートしていない) 場合、関数は親オブジェクトの IAccessible インターフェイスを取得します。親オブジェクトは 、IAccessible インターフェイスを介して子要素に関する情報を提供する必要があります。

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

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

例

次のコード例は、このメソッドが 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))
    {
        // Do something with the accessible object, then release it.        
        // ... 
        pAcc->Release();
    }
}

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2003 (デスクトップアプリのみ)
対象プラットフォーム	Windows
ヘッダー	oleacc.h
Library	Oleacc.lib
[DLL]	Oleacc.dll
再頒布可能パッケージ	SP6 以降および Windows 95 を使用した Windows NT 4.0 のアクティブなアクセシビリティ 1.3 RDK