Share via


IVsThreadedWaitDialog2.StartWaitDialog Method

Definition

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

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