GetDocumentation2 Method

ITypeLib2.GetDocumentation2 Method (Int32, String, Int32, String)

 

Retrieves the library's documentation string, the complete Help file name and path, the localization context to use, and the context ID for the library Help topic in the Help file.

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

void GetDocumentation2(
	int index,
	out string pbstrHelpString,
	out int pdwHelpStringContext,
	out string pbstrHelpStringDll
)

Parameters

index
Type: System.Int32

An index of the type description whose documentation is to be returned; if index is -1, the documentation for the library is returned.

pbstrHelpString
Type: System.String

When this method returns, contains a BSTR that specifies the name of the specified item. If the caller does not need the item name, pbstrHelpString can be null. This parameter is passed uninitialized.

pdwHelpStringContext
Type: System.Int32

When this method returns, contains the Help localization context. If the caller does not need the Help context, pdwHelpStringContext can be null. This parameter is passed uninitialized.

pbstrHelpStringDll
Type: System.String

When this method returns, contains a BSTR that specifies the fully qualified name of the file containing the DLL used for Help file. If the caller does not need the file name, pbstrHelpStringDll can be null. This parameter is passed uninitialized.

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:
© 2016 Microsoft