IVsThreadedWaitDialog2.UpdateProgress Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assemblies:: Microsoft.VisualStudio.Shell.14.0.dll, Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assemblies:: Microsoft.VisualStudio.Shell.15.0.dll, Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assembly:: Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Updates the progress on the wait dialog.

public:
 int UpdateProgress(System::String ^ szUpdatedWaitMessage, System::String ^ szProgressText, System::String ^ szStatusBarText, int iCurrentStep, int iTotalSteps, bool fDisableCancel, [Runtime::InteropServices::Out] bool % pfCanceled);

int UpdateProgress(std::wstring const & szUpdatedWaitMessage, std::wstring const & szProgressText, std::wstring const & szStatusBarText, int iCurrentStep, int iTotalSteps, bool fDisableCancel, [Runtime::InteropServices::Out] bool & pfCanceled);

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

abstract member UpdateProgress : string * string * string * int * int * bool * bool -> int

Public Function UpdateProgress (szUpdatedWaitMessage As String, szProgressText As String, szStatusBarText As String, iCurrentStep As Integer, iTotalSteps As Integer, fDisableCancel As Boolean, ByRef pfCanceled As Boolean) As Integer

Parameters

szUpdatedWaitMessage: String

The updated wait message. Can be null.

szProgressText: String

The text accompanying the progress bar. Can be null.

szStatusBarText: String

The status bar text. Can be null.

iCurrentStep: Int32

The number of steps completed so far.

iTotalSteps: Int32

The total number of steps.

fDisableCancel: Boolean

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

pfCanceled: Boolean

[out] true if the operation was canceled.

Returns

Int32

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

Remarks

This method is safe to access from any thread.

Applies to

Share via