ITypeInfo::GetDocumentation メソッド (oaidl.h)

指定した型の説明に対するヘルプ トピックのドキュメント文字列、ヘルプ ファイルの完全限定名とパス、およびコンテキスト ID を取得します。

構文

HRESULT GetDocumentation(
  [in]  MEMBERID memid,
  [out] BSTR     *pBstrName,
  [out] BSTR     *pBstrDocString,
  [out] DWORD    *pdwHelpContext,
  [out] BSTR     *pBstrHelpFile
);

パラメーター

[in] memid

ドキュメントを取得するメンバーの ID。

[out] pBstrName

指定した項目の名前。 呼び出し元が項目名を必要としない場合、 pBstrName は null にすることができます。

[out] pBstrDocString

指定した項目のドキュメント文字列。 呼び出し元にドキュメント文字列が必要ない場合は、 pBstrDocString を null にすることができます。

[out] pdwHelpContext

ヘルプのローカライズ コンテキスト。 呼び出し元がヘルプ コンテキストを必要としない場合は、null にすることができます。

[out] pBstrHelpFile

ヘルプ ファイルに使用される DLL を含むファイルの完全修飾名。 呼び出し元がファイル名を必要としない場合は、null にすることができます。

戻り値

このメソッドは、これらの値のいずれかを返すことができます。

リターン コード	説明
S_ok	正常終了しました。
E_INVALIDARG	1 つ以上の引数が無効です。
E_OUTOFMEMORY	操作を完了するにはメモリが不足しています。

注釈

関数 GetDocumentation は、memid パラメーターで指定されたメンバーのドキュメントへのアクセスを提供します。 渡された memid がMEMBERID_NIL場合は、型の説明に関するドキュメントが返されます。

型の説明が別の型の説明から継承されている場合、この関数は、必要に応じて基本型の説明に対して再帰的に実行され、要求されたメンバー ID を持つアイテムを検索します。

呼び出し元は SysFreeString を使用して、 pBstrName、 pBstrDocString、および pBstrHelpFile によって参照される BSTR を解放する必要があります。

要件

要件	値
対象プラットフォーム	Windows
ヘッダー	oaidl.h

こちらもご覧ください

Itypeinfo