This documentation is archived and is not being maintained.

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
)
void GetDocumentation (
	int index, 
	/** @attribute OutAttribute() */ /** @ref */ String strName, 
	/** @attribute OutAttribute() */ /** @ref */ String strDocString, 
	/** @attribute OutAttribute() */ /** @ref */ int dwHelpContext, 
	/** @attribute OutAttribute() */ /** @ref */ String strHelpFile
)
Not applicable.

Parameters

index

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

strName

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

strDocString

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

dwHelpContext

Returns the Help context identifier associated with the specified item.

strHelpFile

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

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

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0
Show: