IVsDocOutlineProvider::GetOutlineCaption Method (VSOUTLINECAPTION, String^)

 

Returns a document outline caption.

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

int GetOutlineCaption(
	VSOUTLINECAPTION nCaptionType,
	[OutAttribute] String^% pbstrCaption
)

Parameters

nCaptionType
Type: Microsoft.VisualStudio.Shell.Interop::VSOUTLINECAPTION

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

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.

From vsshell.idl:

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