IVsThreadedWaitDialog3.StartWaitDialog Method

Definition

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:
 void StartWaitDialog(System::String ^ szWaitCaption, System::String ^ szWaitMessage, System::String ^ szProgressText, System::Object ^ varStatusBmpAnim, System::String ^ szStatusBarText, int iDelayToShowDialog, bool fIsCancelable, bool fShowMarqueeProgress);
public:
 void StartWaitDialog(Platform::String ^ szWaitCaption, Platform::String ^ szWaitMessage, Platform::String ^ szProgressText, Platform::Object ^ varStatusBmpAnim, Platform::String ^ szStatusBarText, int iDelayToShowDialog, bool fIsCancelable, bool fShowMarqueeProgress);
void 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 void 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 -> unit
Public Sub 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)

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.

Remarks

This method is safe to access from any thread.

Applies to