Export (0) Print
Expand All

ITypeInfo.GetDocumentation Method

Retrieves the documentation string, the complete Help file name and path, and the context ID for the Help topic for a specified type description.

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 ID of the member whose documentation is to be returned.

strName
Type: System.String

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

strHelpFile
Type: System.String

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

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

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1

Windows Phone 8.1, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft