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

Definition

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, out string strName, out string strDocString, out int dwHelpContext, out string strHelpFile);

Parameters

index
Int32

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

strName
String

When this method returns, contains a string that specifies the name of the specified item. 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 the Help context identifier associated with the specified item. This parameter is passed uninitialized.

strHelpFile
String

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

Implements

Remarks

For more information, see ITypeLib::GetDocumentation method.

Applies to

Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1
UWP 10.0