Share via

IVsCommonMessagePump.SetWaitText(String) Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Shell.Interop
Assemblies:
Microsoft.VisualStudio.Shell.14.0.dll, Microsoft.VisualStudio.Shell.Interop.10.0.dll
Assemblies:
Microsoft.VisualStudio.Shell.15.0.dll, Microsoft.VisualStudio.Shell.Interop.10.0.dll
Assembly:
Microsoft.VisualStudio.Shell.Interop.10.0.dll
Assembly:
Microsoft.VisualStudio.Interop.dll
Package:
Microsoft.VisualStudio.Interop v17.11.40262

Specifies the text for the default wait UI that explains the reason for the wait.

public:
 int SetWaitText(System::String ^ pszWaitText);
public:
 int SetWaitText(Platform::String ^ pszWaitText);
int SetWaitText(std::wstring const & pszWaitText);
public int SetWaitText (string pszWaitText);
abstract member SetWaitText : string -> int
Public Function SetWaitText (pszWaitText As String) As Integer

Parameters

pszWaitText
String

The optional title for the default wait UI. If nullL or the empty string, then the application name is used as the title.

Returns

Int32

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

Applies to