IVsHiddenRegion.SetBanner(String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

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.

Sets the banner for the hidden region.

public:
 int SetBanner(System::String ^ pszBanner);

public:
 int SetBanner(Platform::String ^ pszBanner);

int SetBanner(std::wstring const & pszBanner);

public int SetBanner (string pszBanner);

abstract member SetBanner : string -> int

Public Function SetBanner (pszBanner As String) As Integer

Parameters

pszBanner: String

[in] Pointer to the banner for the hidden region.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From textmgr.idl:

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.

Applies to