IVsThreadedWaitDialog4.StartWaitDialogEx Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Determines whether StartWaitDialog(Ex) has actually started a dialog.If StartWaitDialog (or StartWaitDialogEx) is called multiple times without calling EndWaitDialog, only the first will start the dialog. Subsequent calls will just be no-ops. This makes it difficult to determine how often a call site caused the dialog to show. pfStarted will be set to true if the call to StartWaitDialogEx started the wait dialog (or started the timer to show the dialog).

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

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

bool StartWaitDialogEx(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 bool StartWaitDialogEx (string szWaitCaption, string szWaitMessage, string szProgressText, object varStatusBmpAnim, string szStatusBarText, int iDelayToShowDialog, bool fIsCancelable, bool fShowMarqueeProgress);

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

Public Function StartWaitDialogEx (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 Boolean

Parameters

szWaitCaption

String

The wait dialog caption

szWaitMessage

String

The wait message.

szProgressText

String

The progress text.

varStatusBmpAnim

Object

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

szStatusBarText

String

The status bar text. Can be NULL.

iDelayToShowDialog

Int32

The number of seconds to delay showing the dialog.

fIsCancelable

Boolean

True if there is a cancelable button on the dialog, otherwise false.

fShowMarqueeProgress

Boolean

Marquee-style progress will be shown with VARIANT_BOOL, otherwise no visible progress bar.

Returns

Boolean

True if the dialog was actually displayed, or false if it was already visible.

Remarks

This method is safe to access from any thread.