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

Artigo
04/19/2018

Dica

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

Namespace: System.Runtime.InteropServices
Assembly: mscorlib (em mscorlib.dll)

Sintaxe

void GetDocumentation(
    int index,
    out string strName,
    out string strDocString,
    out int dwHelpContext,
    out string strHelpFile
)

void GetDocumentation(
    int index,
    [OutAttribute] String^% strName,
    [OutAttribute] String^% strDocString,
    [OutAttribute] int% dwHelpContext,
    [OutAttribute] String^% strHelpFile
)

abstract GetDocumentation : 
        index:int *
        strName:string byref *
        strDocString:string byref *
        dwHelpContext:int byref *
        strHelpFile:string byref -> unit

Sub GetDocumentation (
    index As Integer,
    <OutAttribute> ByRef strName As String,
    <OutAttribute> ByRef strDocString As String,
    <OutAttribute> ByRef dwHelpContext As Integer,
    <OutAttribute> ByRef strHelpFile As String
)

Parâmetros

index
Type: System.Int32

ID do membro cuja documentação será retornada.

strName
Type: System.String

No retorno bem-sucedido, o nome do método do item.

strDocString
Type: System.String

No retorno bem-sucedido, a cadeia de caracteres de documentação do item especificado.

dwHelpContext
Type: System.Int32

No retorno bem-sucedido, uma referência ao contexto da Ajuda associado ao item especificado.

strHelpFile
Type: System.String

No retorno bem-sucedido, o nome totalmente qualificado do arquivo de Ajuda.

Comentários

Para obter informações adicionais sobre ITypeInfo::GetDocumentation, consulte a biblioteca MSDN.

Informações de Versão

.NET Framework
Disponível desde 1.1

Confira Também

Interface UCOMITypeInfo
Namespace System.Runtime.InteropServices

Retornar ao início

Compartilhar via