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

  • [アーティクル]

ライブラリのドキュメント文字列、ヘルプ ファイルの完全な名前とパス、およびヘルプ ファイル内のライブラリ ヘルプ トピックのコンテキスト識別子を取得します。

構文

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

パラメーター

[in] index

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

[out] pBstrName

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

[out] pBstrDocString

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

[out] pdwHelpContext

指定したアイテムに関連付けられているヘルプ コンテキスト識別子 (ID)。 呼び出し元にヘルプ コンテキスト ID が必要ない場合は、 pdwHelpContext を null にすることができます。

[out] pBstrHelpFile

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

戻り値

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

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

注釈

呼び出し元は、パラメーター pBstrName、 pBstrDocString、 および pBstrHelpFile を解放する必要があります。

要件

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

こちらもご覧ください

ITypeLib