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

 

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.

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

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

Parameters

index
Type: System.Int32

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

strName
Type: System.String

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

strDocString
Type: System.String

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

dwHelpContext
Type: System.Int32

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

strHelpFile
Type: System.String

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

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

Universal Windows Platform
Available since 8
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Windows Phone
Available since 8.1
Return to top
Show: