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

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

IAccessible::get_accHelp メソッドは、オブジェクトの Help プロパティ文字列を取得します。すべてのオブジェクトがこのプロパティをサポートしているわけではありません。

構文

HRESULT get_accHelp(
  [in]          VARIANT varChild,
  [out, retval] BSTR    *pszHelp
);

パラメーター

[in] varChild

型: VARIANT

取得したヘルプ情報がオブジェクトに属するか、オブジェクトの子要素の 1 つに属するかを指定します。このパラメーターは、CHILDID_SELF (オブジェクトに関する情報を取得するため) または子 ID (オブジェクトの子要素の 1 つに関する情報を取得する場合) のいずれかです。 VARIANT の初期化の詳細については、「パラメーターでの子 ID の使用方法」を参照してください。

[out, retval] pszHelp

種類: BSTR*

指定したオブジェクトのヘルプ情報を含むローカライズされた文字列を受け取る BSTR のアドレス。使用可能なヘルプ情報がない場合は NULL 。

戻り値

型: HRESULT

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

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

エラー	説明
S_FALSE	ヘルプ情報はありません。
E_INVALIDARG	引数が有効ではありません。
DISP_E_MEMBERNOTFOUND	オブジェクトは、このプロパティをサポートしていません。

注釈

このプロパティをサポートする定義済みコントロールと共通コントロールはありません。

サーバー開発者への注意: このプロパティから返される文字列をローカライズします。

このプロパティは文字列を返しますが、 IAccessible::get_accHelpTopic は WinHelp のヘルプトピックにアクセスできます。オブジェクトは IAccessible::get_accHelp と IAccessible:: get_accHelpTopic の両方をサポートする必要はありませんが、少なくとも 1 つをサポートする必要があります。文字列を簡単に返す場合は、 IAccessible::get_accHelp をサポートする必要があります。それ以外の場合は 、IAccessible::get_accHelpTopic をサポートする必要があります。両方がサポートされている場合は、 IAccessible::get_accHelpTopic により詳細な情報が提供されます。

サーバーの例

次のコード例は、カスタムリストボックスに対してこのメソッドを実装する方法の 1 つを示しています。リスト内の連絡先の状態に応じて、異なるテキストが表示されます。わかりやすくするために、この例では返される文字列をローカライズしません。


// m_pControl is the custom control that returns this accessible object. 
// 'online' is an enumerated value. 

HRESULT STDMETHODCALLTYPE AccServer::get_accHelp( 
    VARIANT varChild,
    BSTR *pszHelp)
{
    *pszHelp = NULL;
    if (varChild.vt != VT_I4)
    {
        return E_INVALIDARG;
    }
    if (varChild.lVal == CHILDID_SELF)
    {
        *pszHelp = SysAllocString(L"Contact list.");
    }
    else
    {
        int index = (int)varChild.lVal - 1;
        CustomListControlItem* pItem = m_pControl->GetItemAt(index);
        if (pItem == NULL)
        {
            return E_INVALIDARG;
        }
        if (pItem->GetStatus() == online)
        {
            *pszHelp = SysAllocString(L"Online contact.");
        }
        else 
        {
            *pszHelp = SysAllocString(L"Offline contact.");
        }
    }
    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