IAccessible::get_accFocus メソッド (oleacc.h)

[アーティクル]
02/29/2024

IAccessible::get_accFocus メソッドは、キーボードフォーカスを持つオブジェクトを取得します。キーボードフォーカスを受け取る可能性のあるすべてのオブジェクトは、このプロパティをサポートする必要があります。

構文

HRESULT get_accFocus(
  [out, retval] VARIANT *pvarChild
);

パラメーター

[out, retval] pvarChild

型: VARIANT*

フォーカスがあるオブジェクトに関する情報を受け取る VARIANT 構造体のアドレス。次の表では、 pvarID で返される情報について説明します。

値	意味
VT_EMPTY	[なし] : このオブジェクトも子オブジェクトにもキーボードフォーカスはありません。
VT_I4	lVal がCHILDID_SELF。オブジェクト自体にキーボードフォーカスがあります。
VT_I4	lVal には、キーボードフォーカスを持つ子要素の子 ID が含まれます。
VT_DISPATCH	pdispVal メンバーは、キーボードフォーカスを持つ子オブジェクトの IDispatch インターフェイスのアドレスです。

戻り値

型: HRESULT

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

成功しなかった場合は、次のテーブルの値の 1 つ、または別の標準 COM エラーコードを返します。サーバーはこれらの値を返しますが、クライアントは常に出力パラメーターをチェックして、有効な値が含まれていることを確認する必要があります。詳細については、「 IAccessible 戻り値の確認」を参照してください。

エラー	説明
S_FALSE	オブジェクトはウィンドウですが、前景ウィンドウではありません。
DISP_E_MEMBERNOTFOUND	オブジェクトは、このプロパティをサポートしていません。

注釈

キーボードフォーカスの概念は、アクティブウィンドウの概念に関連しています。アクティブウィンドウは、ユーザーが作業する前景ウィンドウです。キーボードフォーカスを持つオブジェクトは、アクティブウィンドウまたはアクティブウィンドウの子オブジェクトです。

コンテナー内の 1 つのオブジェクトまたは項目だけが、一度にフォーカスを持ちます。キーボードフォーカスを持つオブジェクトが、常に選択されているオブジェクトであるとは限りません。選択とフォーカスの違いの詳細については、「選択とフォーカスのプロパティとメソッド」を参照してください。

このメソッドは、pvarID の IDispatch インターフェイスポインターまたは子 ID を返します。 IDispatch インターフェイスポインターまたは子 ID の使用方法の詳細については、「パラメーターでの子 ID の使用方法」を参照してください。

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

サーバーの例

次のコード例は、カスタムの単一選択リストボックスに対してこのメソッドを実装できる方法を示しています。コントロールにフォーカスがない場合、VT_EMPTYは HWND の標準のアクセシビリティ対応オブジェクトによってバリアントで返されます。コントロールにフォーカスがあり、項目が選択されている場合は、その項目の子 ID が返されます。選択されていない場合は、CHILDID_SELFが返されます。


// m_pControl is the control object that is served by this implementation. 
// m_pStdAccessibleObject is the object returned by CreateStdAccessibleObject. 

HRESULT STDMETHODCALLTYPE AccServer::get_accFocus(VARIANT *pvarChild)
{
    FAIL_IF_NO_CONTROL;  // Macro that checks for existence of control. 

    HRESULT hr = m_pStdAccessibleObject->get_accFocus(pvarChild);  
    if (pvarChild->vt != VT_I4)
    {
        return hr;
    }
    else
    {
        int index = m_pControl->GetSelectedIndex();
        if (index <0)
        {
            pvarChild->lVal = CHILDID_SELF;
        }
        else
        {
            // Convert to 1-based index for child ID. 
            pvarChild->lVal = index + 1;
        }
    }
    return S_OK;
};

要件

要件	値
サポートされている最小のクライアント	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