UCOMITypeLib.GetDocumentation メソッド

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

UCOMITypeLib.GetDocumentation メソッド

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

名前空間: System.Runtime.InteropServices
アセンブリ: 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 UCOMITypeLib
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

ドキュメントが返される型の説明のインデックス。

strName

指定した項目の名前を格納している文字列を返します。

strDocString

指定した項目のドキュメント文字列を格納している文字列を返します。

dwHelpContext

指定した項目に関連付けられたヘルプ コンテキスト識別子を返します。

strHelpFile

ヘルプ ファイルの完全限定名を格納している文字列を返します。

解説

ITypeLib::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、1.1、1.0

参照

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