ITypeInfo.GetDocumentation(Int32, String, String, Int32, String) Método

Definição

Recupera a cadeia de documentação, o nome e caminho completos do ficheiro de Ajuda, e o ID de contexto do tópico de Ajuda para uma descrição de tipo especificada.

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)

Parâmetros

index
Int32

O documento de identificação do membro cuja documentação deve ser devolvida.

strName
String

Quando este método regressa, contém o nome do método item. Este parâmetro é passado sem inicializar.

strDocString
String

Quando este método retorna, contém a cadeia de documentação do item especificado. Este parâmetro é passado sem inicializar.

dwHelpContext
Int32

Quando este método retorna, contém uma referência ao contexto Ajuda associado ao item especificado. Este parâmetro é passado sem inicializar.

strHelpFile
String

Quando este método regressa, contém o nome totalmente qualificado do ficheiro de Ajuda. Este parâmetro é passado sem inicializar.

Observações

Para mais informações, consulte o método ITypeInfo::GetDocumentation.

Aplica-se a