IVsThreadedWaitDialog2.StartWaitDialogWithPercentageProgress Method

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

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

Syntax

'Declaration
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

int StartWaitDialogWithPercentageProgress(
    string szWaitCaption,
    string szWaitMessage,
    string szProgressText,
    Object varStatusBmpAnim,
    string szStatusBarText,
    bool fIsCancelable,
    int iDelayToShowDialog,
    int iTotalSteps,
    int iCurrentStep
)

int StartWaitDialogWithPercentageProgress(
    [InAttribute] String^ szWaitCaption, 
    [InAttribute] String^ szWaitMessage, 
    [InAttribute] String^ szProgressText, 
    [InAttribute] Object^ varStatusBmpAnim, 
    [InAttribute] String^ szStatusBarText, 
    [InAttribute] bool fIsCancelable, 
    [InAttribute] int iDelayToShowDialog, 
    [InAttribute] int iTotalSteps, 
    [InAttribute] int iCurrentStep
)

abstract StartWaitDialogWithPercentageProgress : 
        szWaitCaption:string * 
        szWaitMessage:string * 
        szProgressText:string * 
        varStatusBmpAnim:Object * 
        szStatusBarText:string * 
        fIsCancelable:bool * 
        iDelayToShowDialog:int * 
        iTotalSteps:int * 
        iCurrentStep:int -> int

function StartWaitDialogWithPercentageProgress(
    szWaitCaption : String, 
    szWaitMessage : String, 
    szProgressText : String, 
    varStatusBmpAnim : Object, 
    szStatusBarText : String, 
    fIsCancelable : boolean, 
    iDelayToShowDialog : int, 
    iTotalSteps : int, 
    iCurrentStep : int
) : int

Parameters

• szWaitCaption
  Type: String

  The wait caption.

• szWaitMessage
  Type: String

  The wait message.

• szProgressText
  Type: String

  The text accompanying the progress bar. Can be nulla null reference (Nothing in Visual Basic).

• varStatusBmpAnim
  Type: Object

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

• szStatusBarText
  Type: String

  The text on the status bar. Can be nulla null reference (Nothing in Visual Basic).

• fIsCancelable
  Type: Boolean

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

• iDelayToShowDialog
  Type: Int32

  The number of seconds to delay showing the dialog.

• iTotalSteps
  Type: Int32

  The total number of steps.

• iCurrentStep
  Type: Int32

  The number of steps that have been completed so far.

Return Value

Type: 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.

See Also

Reference

IVsThreadedWaitDialog2 Interface

Microsoft.VisualStudio.Shell.Interop Namespace