ITypeLib2::GetDocumentation Method (Int32, String^%, String^%, Int32%, String^%)

.NET Framework (current version)

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)

Syntax

C++

void GetDocumentation(
	int index,
	[OutAttribute] String^% strName,
	[OutAttribute] String^% strDocString,
	[OutAttribute] int% dwHelpContext,
	[OutAttribute] String^% strHelpFile
)

Parameters

index: Type: System::Int32
An index of the type description whose documentation is to be returned.

strName: Type: System::String^%
When this method returns, contains a string that specifies the name of the specified item. This parameter is passed uninitialized.

strDocString: Type: System::String^%
When this method returns, contains 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 specifies the fully qualified name of the Help file. This parameter is passed uninitialized.

Implements

ITypeLib::GetDocumentation(Int32, String^%, String^%, Int32%, String^%)

Remarks

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

Version Information

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