ITypeLib2.GetDocumentation2 メソッド

.NET Framework クラス ライブラリ リファレンス

ITypeLib2.GetDocumentation2 メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

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

名前空間: System.Runtime.InteropServices.ComTypes
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Sub GetDocumentation2 ( _
    index As Integer, _
    <OutAttribute> ByRef pbstrHelpString As
 String, _
    <OutAttribute> ByRef pdwHelpStringContext As
 Integer, _
    <OutAttribute> ByRef pbstrHelpStringDll As
 String _
)

Visual Basic (使用法)

Dim instance As ITypeLib2
Dim index As Integer
Dim pbstrHelpString As String
Dim pdwHelpStringContext As Integer
Dim pbstrHelpStringDll As String

instance.GetDocumentation2(index, pbstrHelpString, pdwHelpStringContext, pbstrHelpStringDll)

C#

void GetDocumentation2 (
    int index,
    out string pbstrHelpString,
    out int pdwHelpStringContext,
    out string pbstrHelpStringDll
)

C++

void GetDocumentation2 (
    int index, 
    [OutAttribute] String^% pbstrHelpString, 
    [OutAttribute] int% pdwHelpStringContext, 
    [OutAttribute] String^% pbstrHelpStringDll
)

J#

void GetDocumentation2 (
    int index, 
    /** @attribute OutAttribute() */ /** @ref */ String pbstrHelpString, 
    /** @attribute OutAttribute() */ /** @ref */ int pdwHelpStringContext,
 
    /** @attribute OutAttribute() */ /** @ref */ String pbstrHelpStringDll
)

JScript

JScript では、値型の引数は参照渡しされません。

パラメータ

index

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

pbstrHelpString

このメソッドから制御が戻るときに、指定した項目の名前を指定する BSTR を格納します。呼び出し元が項目名を必要としない場合、pbstrHelpString は null 参照 (Visual Basic では Nothing) にできます。このパラメータは初期化せずに渡されます。

pdwHelpStringContext

このメソッドから制御が戻るときに、ヘルプのローカリゼーション コンテキストを格納します。呼び出し元がヘルプ コンテキストを必要としない場合、pdwHelpStringContext は null 参照 (Visual Basic では Nothing) にできます。このパラメータは初期化せずに渡されます。

pbstrHelpStringDll

このメソッドから制御が戻るときに、ヘルプ ファイルに使用される DLL を含むファイルの完全修飾名を指定する BSTR を格納します。呼び出し元がファイル名を必要としない場合、pbstrHelpStringDll は null 参照 (Visual Basic では Nothing) にできます。このパラメータは初期化せずに渡されます。

戻り値
返された HRESULT から取得される戻り値は、次のいずれかになります。

戻り値	説明
S_OK	成功。
STG_E_INSUFFICIENTMEMORY	メモリが不足しています。
E_INVALIDARG	1 つ以上の引数が無効です。

解説

ITypeLib2::GetDocumentation2 の詳細については、MSDN ライブラリを参照してください。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ITypeLib2 インターフェイス
ITypeLib2 メンバ
System.Runtime.InteropServices.ComTypes 名前空間