Export (0) Print
Expand All

UCOMITypeLib.GetDocumentation Method

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
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

Index of the type description whose documentation is to be returned.

strName
Type: System.String

Returns a string that contains the name of the specified item.

strDocString
Type: System.String

Returns a string that contains the documentation string for the specified item.

dwHelpContext
Type: System.Int32

Returns the Help context identifier associated with the specified item.

strHelpFile
Type: System.String

Returns a string that contains the fully qualified name of the Help file.

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

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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