Edit

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

  • Reference

Definition

Namespace:
System.Runtime.InteropServices.ComTypes
Assembly:
System.Runtime.InteropServices.dll
Assembly:
mscorlib.dll
Assembly:
netstandard.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

The index of the type description whose documentation is to be returned.

strName
String

When this method returns, contains a string that represents the name of the specified item. This parameter is passed uninitialized.

strDocString
String

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

dwHelpContext
Int32

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

strHelpFile
String

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

Remarks

For more information, see ITypeLib::GetDocumentation method.

Applies to