IVsThreadedWaitDialog2.StartWaitDialog 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

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.

Displays an instance of a wait dialog.

public:
 int StartWaitDialog(System::String ^ szWaitCaption, System::String ^ szWaitMessage, System::String ^ szProgressText, System::Object ^ varStatusBmpAnim, System::String ^ szStatusBarText, int iDelayToShowDialog, bool fIsCancelable, bool fShowMarqueeProgress);

public:
 int StartWaitDialog(Platform::String ^ szWaitCaption, Platform::String ^ szWaitMessage, Platform::String ^ szProgressText, Platform::Object ^ varStatusBmpAnim, Platform::String ^ szStatusBarText, int iDelayToShowDialog, bool fIsCancelable, bool fShowMarqueeProgress);

int StartWaitDialog(std::wstring const & szWaitCaption, std::wstring const & szWaitMessage, std::wstring const & szProgressText, winrt::Windows::Foundation::IInspectable const & varStatusBmpAnim, std::wstring const & szStatusBarText, int iDelayToShowDialog, bool fIsCancelable, bool fShowMarqueeProgress);

public int StartWaitDialog (string szWaitCaption, string szWaitMessage, string szProgressText, object varStatusBmpAnim, string szStatusBarText, int iDelayToShowDialog, bool fIsCancelable, bool fShowMarqueeProgress);

abstract member StartWaitDialog : string * string * string * obj * string * int * bool * bool -> int

Public Function StartWaitDialog (szWaitCaption As String, szWaitMessage As String, szProgressText As String, varStatusBmpAnim As Object, szStatusBarText As String, iDelayToShowDialog As Integer, fIsCancelable As Boolean, fShowMarqueeProgress As Boolean) As Integer

Parameters

szWaitCaption: String

The dialog caption.

szWaitMessage: String

The wait message.

szProgressText: String

The text that accompanies the progress bar. Can be null.

varStatusBmpAnim: Object

Should be a VT_INT_PTR containing a valid BMP, or VT_NULL.

szStatusBarText: String

The text on the status bar. Can be null.

iDelayToShowDialog: Int32

The number of seconds to delay showing the dialog.

fIsCancelable: Boolean

true if there should be a Cancel button on the dialog, otherwise false.

fShowMarqueeProgress: Boolean

true if there should be a marquee-style progress bar on the dialog, otherwise false.

Returns

Int32

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

Remarks

This method is safe to access from any thread.

Applies to

Share via