Share via


IVsDocOutlineProvider.GetOutlineCaption Method

Returns a document outline caption.

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

Syntax

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

Parameters

  • pbstrCaption
    Type: System.String%

    [out] Pointer to a BSTR that contains the document outline caption.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

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

.NET Framework Security

See Also

Reference

IVsDocOutlineProvider Interface

Microsoft.VisualStudio.Shell.Interop Namespace