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

Definition

Namespace:

System.Runtime.InteropServices

Assembly:

System.Windows.Forms.Design.dll

Retrieves the library's documentation string, the complete Help file name and path, and the context identifier for the library Help topic in the Help file.

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

Index of the type description whose documentation is to be returned.

strName

String

Returns a string that contains the name of the specified item.

strDocString

String

Returns a string that contains the documentation string for the specified item.

dwHelpContext

Int32

Returns the Help context identifier associated with the specified item.

strHelpFile

String

Returns a string that contains the fully qualified name of the Help file.

Remarks

For additional information about ITypeLib::GetDocumentation, see the MSDN Library.