IVsThreadedWaitDialog2.StartWaitDialog Method
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)
Syntax
'Declaration
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
int StartWaitDialog(
string szWaitCaption,
string szWaitMessage,
string szProgressText,
Object varStatusBmpAnim,
string szStatusBarText,
int iDelayToShowDialog,
bool fIsCancelable,
bool fShowMarqueeProgress
)
int StartWaitDialog(
[InAttribute] String^ szWaitCaption,
[InAttribute] String^ szWaitMessage,
[InAttribute] String^ szProgressText,
[InAttribute] Object^ varStatusBmpAnim,
[InAttribute] String^ szStatusBarText,
[InAttribute] int iDelayToShowDialog,
[InAttribute] bool fIsCancelable,
[InAttribute] bool fShowMarqueeProgress
)
abstract StartWaitDialog :
szWaitCaption:string *
szWaitMessage:string *
szProgressText:string *
varStatusBmpAnim:Object *
szStatusBarText:string *
iDelayToShowDialog:int *
fIsCancelable:bool *
fShowMarqueeProgress:bool -> int
function StartWaitDialog(
szWaitCaption : String,
szWaitMessage : String,
szProgressText : String,
varStatusBmpAnim : Object,
szStatusBarText : String,
iDelayToShowDialog : int,
fIsCancelable : boolean,
fShowMarqueeProgress : boolean
) : int
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 nulla null reference (Nothing in Visual Basic).
- 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 nulla null reference (Nothing in Visual Basic).
- 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.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.