Nyelv

ITypeLib2.GetDocumentation2(Int32, String, Int32, String) Metódus

Definíció

Lekéri a kódtár dokumentációs sztringjét, a teljes súgófájl nevét és elérési útját, a használni kívánt honosítási környezetet, valamint a súgófájlban található erőforrástár súgótémakörének környezeti azonosítóját.

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)

Paraméterek

index
Int32

Annak a típusleírásnak az indexe, amelynek dokumentációját vissza kell adni; ha index -1, a kódtár dokumentációja lesz visszaadva.

pbstrHelpString
String

Amikor ez a metódus visszatér, egy BSTR-t tartalmaz, amely megadja a megadott elem nevét. Ha a hívónak nincs szüksége az elem nevére, pbstrHelpString lehet null. Ez a paraméter nem inicializálva lesz átadva.

pdwHelpStringContext
Int32

Amikor ez a metódus visszatér, a súgó honosítási környezetét tartalmazza. Ha a hívónak nincs szüksége a súgókörnyezetre, lehetpdwHelpStringContext. null Ez a paraméter nem inicializálva lesz átadva.

pbstrHelpStringDll
String

Amikor ez a metódus visszatér, egy BSTR-t tartalmaz, amely megadja a súgófájlhoz használt DLL-t tartalmazó fájl teljes nevét. Ha a hívónak nincs szüksége a fájlnévre, pbstrHelpStringDll lehet null. Ez a paraméter nem inicializálva lesz átadva.

A következőre érvényes: