Share via


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

Definição

Recupera a cadeia de caracteres de documentação da biblioteca, o nome e o caminho completos do arquivo de Ajuda, o contexto de localização a ser usado e a ID de contexto para o tópico da Ajuda da biblioteca no arquivo 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 retornada; se index for -1, a documentação para a biblioteca será retornada.

pbstrHelpString
String

Quando este método retorna, contém um BSTR que especifica o nome do item especificado. Se o chamador não precisar o nome do item, pbstrHelpString poderá ser null. Este parâmetro é passado não inicializado.

pdwHelpStringContext
Int32

Quando este método é retornado, contém o contexto de localização da Ajuda. Se o chamador não precisar do contexto da Ajuda, pdwHelpStringContext poderá ser null. Este parâmetro é passado não inicializado.

pbstrHelpStringDll
String

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

Aplica-se a