IVsHiddenRegion::SetBanner Method (String^)

Visual Studio 2015

Visual Studio 2013
Visual Studio 2012
Visual Studio 2010
Visual Studio 2008
Visual Studio 2005

Sets the banner for the hidden region.

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

Syntax

C++

int SetBanner(
	String^ pszBanner
)

Parameters

pszBanner: Type: System::String^
[in] Pointer to the banner for the hidden region.

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 textmgr.idl:

C++

HRESULT IVsHiddenRegion::SetBanner(
   [in] LPCWSTR pszBanner
);

The banner is the text displayed when the hidden region is collapsed. The hidden text manager allocates a new string for this method.