IVsCommonMessagePump.SetWaitText Method

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

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assemblies:   Microsoft.VisualStudio.Shell.Interop.10.0 (in Microsoft.VisualStudio.Shell.Interop.10.0.dll)
  Microsoft.VisualStudio.Shell.12.0 (in Microsoft.VisualStudio.Shell.12.0.dll)

Syntax

'Declaration
Function SetWaitText ( _
    pszWaitText As String _
) As Integer

int SetWaitText(
    string pszWaitText
)

int SetWaitText(
    [InAttribute] String^ pszWaitText
)

abstract SetWaitText : 
        pszWaitText:string -> int

function SetWaitText(
    pszWaitText : String
) : int

Parameters

• pszWaitText
  Type: String

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

Return Value

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

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

IVsCommonMessagePump Interface

Microsoft.VisualStudio.Shell.Interop Namespace