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

IAccessible::get_accHelpTopic メソッドは、指定したオブジェクトに関連付けられている WinHelp ファイルの完全なパスを取得します。また、そのファイル内の適切なトピックの識別子も取得します。 すべてのオブジェクトがこのプロパティをサポートしているわけではありません。 このプロパティは、ほとんどサポートされていないか、アプリケーションで使用されます

注IAccessible::get_accHelpTopic は非推奨であり、使用しないでください。

 

構文

HRESULT get_accHelpTopic(
  [out] BSTR    *pszHelpFile,
  [in]  VARIANT varChild,
        long    *pidTopic
);

パラメーター

[out] pszHelpFile

種類: BSTR*

指定したオブジェクトに関連付けられている WinHelp ファイルの完全パスを受け取る BSTR のアドレス。

[in] varChild

型: VARIANT

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

pidTopic

型: long*

[out, retval]指定したオブジェクトに関連付けられているヘルプ ファイル トピックを識別する変数のアドレス。 この値は、 WinHelp 関数に渡す目的のトピックのコンテキスト識別子として使用されます。 WinHelp を呼び出してトピックを表示する場合は、uCommand パラメーターを HELP_CONTEXT に設定し、pidTopic が指す値を DWORD にキャストし、dwData パラメーターとして渡します。

戻り値

型: HRESULT

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

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

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

注釈

ヘルプ ファイルから情報を取得すると、時間とメモリが多くなる可能性があります。

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

要件

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

こちらもご覧ください

HelpTopic プロパティ

Iaccessible

IAccessible::get_accHelp