IVsThreadedWaitDialog3::StartWaitDialog Method (String^, String^, String^, Object^, String^, Int32, Boolean, Boolean)

 

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).

Namespace:   Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.11.0 (in Microsoft.VisualStudio.Shell.Interop.11.0.dll)

void StartWaitDialog(
	String^ szWaitCaption,
	String^ szWaitMessage,
	String^ szProgressText,
	Object^ varStatusBmpAnim,
	String^ szStatusBarText,
	int iDelayToShowDialog,
	bool fIsCancelable,
	bool fShowMarqueeProgress
)

Parameters

szWaitCaption
Type: System::String^

The wait dialog caption

szWaitMessage
Type: System::String^

The wait message.

szProgressText
Type: System::String^

The progress text.

varStatusBmpAnim
Type: System::Object^

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

szStatusBarText
Type: System::String^

The status bar text. Can be NULL.

iDelayToShowDialog
Type: System::Int32

The number of seconds to delay showing the dialog.

fIsCancelable
Type: System::Boolean

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

fShowMarqueeProgress
Type: System::Boolean

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

Return to top
Show: