ITypeInfo.GetDocumentation(Int32, String, String, Int32, String) Method

Definition

Namespace:

System.Runtime.InteropServices.ComTypes

Assembly:

System.Runtime.InteropServices.dll

Retrieves the documentation string, the complete Help file name and path, and the context ID for the Help topic for a specified type description.

public:
 void GetDocumentation(int index, [Runtime::InteropServices::Out] System::String ^ % strName, [Runtime::InteropServices::Out] System::String ^ % strDocString, [Runtime::InteropServices::Out] int % dwHelpContext, [Runtime::InteropServices::Out] System::String ^ % strHelpFile);

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

abstract member GetDocumentation : int * string * string * int * string -> unit

Public Sub GetDocumentation (index As Integer, ByRef strName As String, ByRef strDocString As String, ByRef dwHelpContext As Integer, ByRef strHelpFile As String)

Parameters

index

Int32

The ID of the member whose documentation is to be returned.

strName

String

When this method returns, contains the name of the item method. This parameter is passed uninitialized.

strDocString

String

When this method returns, contains the documentation string for the specified item. This parameter is passed uninitialized.

dwHelpContext

Int32

When this method returns, contains a reference to the Help context associated with the specified item. This parameter is passed uninitialized.

strHelpFile

String

When this method returns, contains the fully qualified name of the Help file. This parameter is passed uninitialized.

Remarks

For more information, see ITypeInfo::GetDocumentation method.