UCOMITypeInfo.GetDocumentation(Int32, String, String, Int32, String) Method

Definition

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

public:
 void GetDocumentation(int index, [Runtime::InteropServices::Out] System::String ^ % strName, [Runtime::InteropServices::Out] System::String ^ % strDocString, [Runtime::InteropServices::Out] int % dwHelpContext, [Runtime::InteropServices::Out] System::String ^ % strHelpFile);
public void GetDocumentation (int index, out string strName, out string strDocString, out int dwHelpContext, out string strHelpFile);
abstract member GetDocumentation : int * string * string * int * string -> unit
Public Sub GetDocumentation (index As Integer, ByRef strName As String, ByRef strDocString As String, ByRef dwHelpContext As Integer, ByRef strHelpFile As String)

Parameters

index
Int32

ID of the member whose documentation is to be returned.

strName
String

On successful return, the name of the item method.

strDocString
String

On successful return, the documentation string for the specified item.

dwHelpContext
Int32

On successful return, a reference to the Help context associated with the specified item.

strHelpFile
String

On successful return, the fully qualified name of the Help file.

Remarks

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

Applies to