Compartilhar via


Método IVsDocOutlineProvider.GetOutlineCaption (VSOUTLINECAPTION, String)

 

Retorna uma legenda de estrutura de tópicos do documento.

Namespace:   Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (em Microsoft.VisualStudio.Shell.Interop.dll)

Sintaxe

int GetOutlineCaption(
    VSOUTLINECAPTION nCaptionType,
    out string pbstrCaption
)
int GetOutlineCaption(
    VSOUTLINECAPTION nCaptionType,
    [OutAttribute] String^% pbstrCaption
)
abstract GetOutlineCaption : 
        nCaptionType:VSOUTLINECAPTION *
        pbstrCaption:string byref -> int
Function GetOutlineCaption (
    nCaptionType As VSOUTLINECAPTION,
    <OutAttribute> ByRef pbstrCaption As String
) As Integer

Parâmetros

  • nCaptionType
    [in] Tipo de legenda.Valor é obtido a partir do VSOUTLINECAPTION enumeração.
  • pbstrCaption
    [out] Ponteiro para um BSTR que contém a legenda de estrutura de tópicos do documento.

Valor de retorno

Type: System.Int32

Se o método for bem-sucedido, ele retorna S_OK.Se ele falhar, ele retorna um código de erro.

Comentários

COM assinatura

De vsshell.idl:

HRESULT IVsDocOutlineProvider::GetOutlineCaption(
   [in] VSOUTLINECAPTION nCaptionType,
   [out] BSTR* pbstrCaption
);

Consulte também

Interface IVsDocOutlineProvider
Namespace Microsoft.VisualStudio.Shell.Interop

Retornar ao topo