ITypeInfo2.GetDocumentation メソッド

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

ITypeInfo2.GetDocumentation メソッド

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

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

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

Visual Basic (宣言)

Sub GetDocumentation ( _
    index As Integer, _
    <OutAttribute> ByRef strName As String,
 _
    <OutAttribute> ByRef strDocString As
 String, _
    <OutAttribute> ByRef dwHelpContext As
 Integer, _
    <OutAttribute> ByRef strHelpFile As
 String _
)

Visual Basic (使用法)

Dim instance As ITypeInfo2
Dim index As Integer
Dim strName As String
Dim strDocString As String
Dim dwHelpContext As Integer
Dim strHelpFile As String

instance.GetDocumentation(index, strName, strDocString, dwHelpContext, strHelpFile)

C#

void GetDocumentation (
    int index,
    out string strName,
    out string strDocString,
    out int dwHelpContext,
    out string strHelpFile
)

C++

void GetDocumentation (
    int index, 
    [OutAttribute] String^% strName, 
    [OutAttribute] String^% strDocString, 
    [OutAttribute] int% dwHelpContext, 
    [OutAttribute] String^% strHelpFile
)

J#

void GetDocumentation (
    int index, 
    /** @attribute OutAttribute() */ /** @ref */ String strName, 
    /** @attribute OutAttribute() */ /** @ref */ String strDocString, 
    /** @attribute OutAttribute() */ /** @ref */ int dwHelpContext,
 
    /** @attribute OutAttribute() */ /** @ref */ String strHelpFile
)

JScript

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

パラメータ

index

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

strName

このメソッドが返されるときに、項目メソッドの名前を格納します。このパラメータは初期化せずに渡されます。

strDocString

このメソッドが返されるときに、指定した項目のドキュメント文字列を格納します。このパラメータは初期化せずに渡されます。

dwHelpContext

このメソッドが返されるときに、指定した項目に関連付けられたヘルプ コンテキストへの参照を格納します。このパラメータは初期化せずに渡されます。

strHelpFile

このメソッドが返されるときに、ヘルプ ファイルの完全修飾名を格納します。このパラメータは初期化せずに渡されます。

解説

ITypeInfo::GetDocumentation の詳細については、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

参照

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