IVsDocOutlineProvider.GetOutlineCaption(VSOUTLINECAPTION, String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Returns a document outline caption.

public:
 int GetOutlineCaption(Microsoft::VisualStudio::Shell::Interop::VSOUTLINECAPTION nCaptionType, [Runtime::InteropServices::Out] System::String ^ % pbstrCaption);

int GetOutlineCaption(Microsoft::VisualStudio::Shell::Interop::VSOUTLINECAPTION nCaptionType, [Runtime::InteropServices::Out] std::wstring const & & pbstrCaption);

public int GetOutlineCaption (Microsoft.VisualStudio.Shell.Interop.VSOUTLINECAPTION nCaptionType, out string pbstrCaption);

abstract member GetOutlineCaption : Microsoft.VisualStudio.Shell.Interop.VSOUTLINECAPTION * string -> int

Public Function GetOutlineCaption (nCaptionType As VSOUTLINECAPTION, ByRef pbstrCaption As String) As Integer

Parameters

nCaptionType: VSOUTLINECAPTION

[in] Caption type. Value is taken from the VSOUTLINECAPTION enumeration.

pbstrCaption: String

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

Returns

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  
);

Applies to

Share via