ITypeLib2::GetDocumentation2 メソッド (oaidl.h)

  • [アーティクル]

ライブラリのドキュメントの文字列、完全なヘルプ ファイルの名前とパス、使用するローカリゼーション コンテキスト、およびヘルプ ファイル内のライブラリ ヘルプ トピック用のコンテキスト ID を取得します。

構文

HRESULT GetDocumentation2(
  [in]  INT   index,
  [in]  LCID  lcid,
  [out] BSTR  *pbstrHelpString,
  [out] DWORD *pdwHelpStringContext,
  [out] BSTR  *pbstrHelpStringDll
);

パラメーター

[in] index

ドキュメントを取得する型の説明のインデックス。 index が -1 の場合は、ライブラリのドキュメントが返されます。

[in] lcid

ロケール識別子です。

[out] pbstrHelpString

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

[out] pdwHelpStringContext

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

[out] pbstrHelpStringDll

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

戻り値

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

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

注釈

タイプ ライブラリ レベルで情報を取得します。 呼び出し元は BSTR パラメーターを解放する必要があります。

この関数は、指定した DLL 内の_DLLGetDocumentation を呼び出して、このアイテムのヘルプ文字列コンテキストがある場合に目的のヘルプ文字列を取得します。 ヘルプ文字列コンテキストが存在しない場合、またはエラーが発生した場合は、 GetDocumentation メソッドに遅延し、関連するドキュメント文字列が返されます。

要件

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

こちらもご覧ください

ITypeLib2