IVsThreadedWaitDialog2.UpdateProgress Method

Updates the progress on the wait dialog.

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 UpdateProgress ( _
    szUpdatedWaitMessage As String, _
    szProgressText As String, _
    szStatusBarText As String, _
    iCurrentStep As Integer, _
    iTotalSteps As Integer, _
    fDisableCancel As Boolean, _
    <OutAttribute> ByRef pfCanceled As Boolean _
) As Integer

int UpdateProgress(
    string szUpdatedWaitMessage,
    string szProgressText,
    string szStatusBarText,
    int iCurrentStep,
    int iTotalSteps,
    bool fDisableCancel,
    out bool pfCanceled
)

int UpdateProgress(
    [InAttribute] String^ szUpdatedWaitMessage, 
    [InAttribute] String^ szProgressText, 
    [InAttribute] String^ szStatusBarText, 
    [InAttribute] int iCurrentStep, 
    [InAttribute] int iTotalSteps, 
    [InAttribute] bool fDisableCancel, 
    [OutAttribute] bool% pfCanceled
)

abstract UpdateProgress : 
        szUpdatedWaitMessage:string * 
        szProgressText:string * 
        szStatusBarText:string * 
        iCurrentStep:int * 
        iTotalSteps:int * 
        fDisableCancel:bool * 
        pfCanceled:bool byref -> int

function UpdateProgress(
    szUpdatedWaitMessage : String, 
    szProgressText : String, 
    szStatusBarText : String, 
    iCurrentStep : int, 
    iTotalSteps : int, 
    fDisableCancel : boolean, 
    pfCanceled : boolean
) : int

Parameters

• szUpdatedWaitMessage
  Type: String

  The updated wait message. Can be nulla null reference (Nothing in Visual Basic).

• szProgressText
  Type: String

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

• szStatusBarText
  Type: String

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

• iCurrentStep
  Type: Int32

  The number of steps completed so far.

• iTotalSteps
  Type: Int32

  The total number of steps.

• fDisableCancel
  Type: Boolean

  If the operation becomes uncancelable, disable the Cancel button by passing true.

• pfCanceled
  Type: Boolean%

  [out] true if the operation was canceled.

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