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

Definition

Namespace:

System.Runtime.InteropServices.ComTypes

Assembly:

System.Runtime.InteropServices.dll

Ruft die Dokumentationszeichenfolge der Bibliothek, den vollständigen Dateinamen und Pfad der Hilfe, den zu verwendenden Lokalisierungskontext und die Kontext-ID des Hilfethemas der Bibliothek in der Hilfedatei ab.

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)

Parameter

index

Int32

Ein Index der Typbeschreibung, deren Dokumentation zurückgegeben werden soll. Wenn index -1 ist, wird die Dokumentation für die Bibliothek zurückgegeben.

pbstrHelpString

String

Enthält nach Rückgabe dieser Methode einen BSTR-Wert, der den Namen des angegebenen Elements angibt. Wenn der Aufrufer den Elementnamen nicht benötigt, kann pbstrHelpString auch null sein. Dieser Parameter wird nicht initialisiert übergeben.

pdwHelpStringContext

Int32

Enthält nach Rückgabe dieser Methode den Lokalisierungskontext der Hilfe. Wenn der Aufrufer den Hilfekontext nicht benötigt, kann pdwHelpStringContext auch null sein. Dieser Parameter wird nicht initialisiert übergeben.

pbstrHelpStringDll

String

Enthält nach Rückgabe dieser Methode einen BSTR-Wert, der den vollqualifizierten Namen der Datei angibt, die die für die Hilfedatei verwendete DLL enthält. Wenn der Aufrufer den Dateinamen nicht benötigt, kann pbstrHelpStringDll auch null sein. Dieser Parameter wird nicht initialisiert übergeben.