ITypeLib2.GetDocumentation2(Int32, String, Int32, String) Método

Definição

Recupera a cadeia de documentação da biblioteca, o nome e caminho completos do ficheiro de Ajuda, o contexto de localização a usar e o ID de contexto para o tópico de Ajuda da biblioteca no ficheiro de Ajuda.

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)

Parâmetros

index
Int32

Um índice da descrição do tipo cuja documentação deve ser devolvida; se index for -1, a documentação da biblioteca é devolvida.

pbstrHelpString
String

Quando este método regressa, contém um BSTR que especifica o nome do item especificado. Se o chamador não precisar do nome do item, pbstrHelpString pode ser null. Este parâmetro é passado sem inicializar.

pdwHelpStringContext
Int32

Quando este método regressa, contém o contexto de localização Help. Se o chamador não precisar do contexto Ajuda, pdwHelpStringContext pode ser null. Este parâmetro é passado sem inicializar.

pbstrHelpStringDll
String

Quando este método retorna, contém um BSTR que especifica o nome totalmente qualificado do ficheiro que contém a DLL usada para o ficheiro de Ajuda. Se o chamador não precisar do nome do ficheiro, pbstrHelpStringDll pode ser null. Este parâmetro é passado sem inicializar.

Aplica-se a