Share via


IVsHiddenRegion.SetBanner Method

Sets the banner for the hidden region.

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

Syntax

'Declaration
Function SetBanner ( _
    pszBanner As String _
) As Integer
int SetBanner(
    string pszBanner
)
int SetBanner(
    [InAttribute] String^ pszBanner
)
abstract SetBanner : 
        pszBanner:string -> int
function SetBanner(
    pszBanner : String
) : int

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:

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.

.NET Framework Security

See Also

Reference

IVsHiddenRegion Interface

Microsoft.VisualStudio.TextManager.Interop Namespace