UCOMITypeInfo.GetDocumentation-Methode

Ruft die Dokumentationszeichenfolge, den vollständigen Namen und Pfad der Hilfedatei sowie die Kontext-ID des Hilfethemas für eine angegebene Typenbeschreibung ab.

Namespace: System.Runtime.InteropServices
Assembly: mscorlib (in mscorlib.dll)

Syntax

'Declaration
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 _
)
'Usage
Dim instance As UCOMITypeInfo
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)

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

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

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 unterstützt die Übergabe von Werttypargumenten als Verweis nicht.

Parameter

• index
  ID des Members, dessen Dokumentation zurückgegeben werden soll.

• strName
  Bei erfolgreicher Rückgabe der Name der Elementmethode.

• strDocString
  Bei erfolgreicher Rückgabe die Dokumentationszeichenfolge für das angegebene Element.

• dwHelpContext
  Bei erfolgreicher Rückgabe ein Verweis auf den mit dem angegebenen Element verknüpften Hilfekontext.

• strHelpFile
  Bei erfolgreicher Rückgabe der voll gekennzeichnete Name der Hilfedatei.

Hinweise

Weitere Informationen über ITypeInfo::GetDocumentation finden Sie in der MSDN Library.

Plattformen

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 unterstützt nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen.

Versionsinformationen

.NET Framework

Unterstützt in: 2.0, 1.1, 1.0

Siehe auch

Referenz

UCOMITypeInfo-Schnittstelle
UCOMITypeInfo-Member
System.Runtime.InteropServices-Namespace