IVsStatusbar.SetText(String) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.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 status bar text in the text area.

public:
 int SetText(System::String ^ pszText);

public:
 int SetText(Platform::String ^ pszText);

int SetText(std::wstring const & pszText);

public int SetText (string pszText);

abstract member SetText : string -> int

Public Function SetText (pszText As String) As Integer

Parameters

pszText: String

[in] The text to display in the status text area.

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 IVsStatusbar::SetText(  
   [in]LPCOLESTR pszText  
);

The animation icon and progress bar overwrite the text area if the text is too long when those methods are called.

Applies to