Edit

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

  • Reference

Definition

Namespace:
System.Runtime.InteropServices.ComTypes
Assembly:
System.Runtime.InteropServices.dll
Assembly:
mscorlib.dll
Assembly:
netstandard.dll

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.

public:
 void GetDocumentation2(int index, [Runtime::InteropServices::Out] System::String ^ % pbstrHelpString, [Runtime::InteropServices::Out] int % pdwHelpStringContext, [Runtime::InteropServices::Out] System::String ^ % pbstrHelpStringDll);
public void GetDocumentation2 (int index, out string pbstrHelpString, out int pdwHelpStringContext, out string pbstrHelpStringDll);
abstract member GetDocumentation2 : int * string * int * string -> unit
Public Sub GetDocumentation2 (index As Integer, ByRef pbstrHelpString As String, ByRef pdwHelpStringContext As Integer, ByRef pbstrHelpStringDll As String)

Parameters

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

Applies to