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

 

Displays an instance of a wait dialog.

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

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

Parameters

szWaitCaption
Type: System::String^

The dialog caption.

szWaitMessage
Type: System::String^

The wait message.

szProgressText
Type: System::String^

The text that accompanies 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.

iDelayToShowDialog
Type: System::Int32

The number of seconds to delay showing the dialog.

fIsCancelable
Type: System::Boolean

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

fShowMarqueeProgress
Type: System::Boolean

true if there should be a marquee-style progress bar on the dialog, otherwise false.

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: