IVsThreadedWaitDialog2::StartWaitDialogWithPercentageProgress Method (String^, String^, String^, Object^, String^, Boolean, Int32, Int32, Int32)

Visual Studio 2015
 

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

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

C#
C++
F#
VB
Copy 
int StartWaitDialogWithPercentageProgress(
	String^ szWaitCaption,
	String^ szWaitMessage,
	String^ szProgressText,
	Object^ varStatusBmpAnim,
	String^ szStatusBarText,
	bool fIsCancelable,
	int iDelayToShowDialog,
	int iTotalSteps,
	int iCurrentStep
)

Parameters

szWaitCaption
Type: System::String^

The wait caption.

szWaitMessage
Type: System::String^

The wait message.

szProgressText
Type: System::String^

The text accompanying the progress bar. Can be null.

varStatusBmpAnim
Type: System::Object^

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

szStatusBarText
Type: System::String^

The text on the status bar. Can be null.

fIsCancelable
Type: System::Boolean

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

iDelayToShowDialog
Type: System::Int32

The number of seconds to delay showing the dialog.

iTotalSteps
Type: System::Int32

The total number of steps.

iCurrentStep
Type: System::Int32

The number of steps that have been completed so far.

Return Value

Type: System::Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Return to top
Show: