IVsThreadedWaitDialog2.StartWaitDialogWithPercentageProgress Method

Definition

Displays a wait dialog with a percentage-based progress bar.

public:
 int 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:
 int StartWaitDialogWithPercentageProgress(Platform::String ^ szWaitCaption, Platform::String ^ szWaitMessage, Platform::String ^ szProgressText, Platform::Object ^ varStatusBmpAnim, Platform::String ^ szStatusBarText, bool fIsCancelable, int iDelayToShowDialog, int iTotalSteps, int iCurrentStep);
int 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 int 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 -> int
Public Function 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) As Integer

Parameters

szWaitCaption
String

The wait caption.

szWaitMessage
String

The wait message.

szProgressText
String

The text accompanying 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.

fIsCancelable
Boolean

true if there should be a Cancel button on the dialog, otherwise false.

iDelayToShowDialog
Int32

The number of seconds to delay showing the dialog.

iTotalSteps
Int32

The total number of steps.

iCurrentStep
Int32

The number of steps that have been completed so far.

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