IOleComponentUIManager.SetStatus(String, UInt32) 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.

Specifies the status text message for the environment's status bar.

public:
 int SetStatus(System::String ^ pwszStatusText, System::UInt32 dwReserved);

public:
 int SetStatus(Platform::String ^ pwszStatusText, unsigned int dwReserved);

int SetStatus(std::wstring const & pwszStatusText, unsigned int dwReserved);

public int SetStatus (string pwszStatusText, uint dwReserved);

abstract member SetStatus : string * uint32 -> int

Public Function SetStatus (pwszStatusText As String, dwReserved As UInteger) As Integer

Parameters

pwszStatusText: String

[in] Specifies the status text message to display.

dwReserved: UInt32

[in] Placeholder parameter; this value is currently ignored.

Returns

Int32

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

Remarks

COM Signature

From oleipc.idl:

HRESULT IOleComponentUIManager::SetStatus(  
   [in] LPCOLESTR pwszStatusText,  
   [in] DWORD dwReserved  
);

Applies to