Share via

IVsThreadedWaitDialog3.StartWaitDialogWithPercentageProgress Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Shell.Interop
Assemblies:
Microsoft.VisualStudio.Shell.14.0.dll, Microsoft.VisualStudio.Shell.Interop.11.0.dll
Assemblies:
Microsoft.VisualStudio.Shell.15.0.dll, Microsoft.VisualStudio.Shell.Interop.11.0.dll
Assembly:
Microsoft.VisualStudio.Shell.Interop.11.0.dll
Assembly:
Microsoft.VisualStudio.Interop.dll
Package:
Microsoft.VisualStudio.Interop v17.11.40262

Starts a wait dialog that shows progress.

public:
 void StartWaitDialogWithPercentageProgress(System::String ^ szWaitCaption, System::String ^ szWaitMessage, System::String ^ szProgressText, System::Object ^ varStatusBmpAnim, System::String ^ szStatusBarText, bool fIsCancelable, int iDelayToShowDialog, int iTotalSteps, int iCurrentStep);
public:
 void StartWaitDialogWithPercentageProgress(Platform::String ^ szWaitCaption, Platform::String ^ szWaitMessage, Platform::String ^ szProgressText, Platform::Object ^ varStatusBmpAnim, Platform::String ^ szStatusBarText, bool fIsCancelable, int iDelayToShowDialog, int iTotalSteps, int iCurrentStep);
void StartWaitDialogWithPercentageProgress(std::wstring const & szWaitCaption, std::wstring const & szWaitMessage, std::wstring const & szProgressText, winrt::Windows::Foundation::IInspectable const & varStatusBmpAnim, std::wstring const & szStatusBarText, bool fIsCancelable, int iDelayToShowDialog, int iTotalSteps, int iCurrentStep);
public void StartWaitDialogWithPercentageProgress (string szWaitCaption, string szWaitMessage, string szProgressText, object varStatusBmpAnim, string szStatusBarText, bool fIsCancelable, int iDelayToShowDialog, int iTotalSteps, int iCurrentStep);
abstract member StartWaitDialogWithPercentageProgress : string * string * string * obj * string * bool * int * int * int -> unit
Public Sub StartWaitDialogWithPercentageProgress (szWaitCaption As String, szWaitMessage As String, szProgressText As String, varStatusBmpAnim As Object, szStatusBarText As String, fIsCancelable As Boolean, iDelayToShowDialog As Integer, iTotalSteps As Integer, iCurrentStep As Integer)

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 text of the status bar.

fIsCancelable
Boolean

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

iDelayToShowDialog
Int32

The number of seconds to delay showing the dialog.

iTotalSteps
Int32

The number of steps.

iCurrentStep
Int32

The index of the current step.

Remarks

This method is safe to access from any thread.

Applies to