Update(String,Int32,Int32) Method

In This Topic

Update the progress of the monitor.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Sub Update( _
   ByVal status As String, _
   ByVal completedSteps As Integer, _
   ByVal maxSteps As Integer _
)

public void Update( 
   string status,
   int completedSteps,
   int maxSteps
)

Parameters

status: A new user status message
completedSteps: The number of steps that have been completed. (should be less than or equal to the maximum number of steps)
maxSteps: The maximum number of steps in this process.

Remarks

Subscribers will be notified of changes whenever Update is called. When updating the maximum number of steps it is best to guess high at first then reduce over time instead of the reverse to give the user the impression of continuous forward progress instead of losing progress.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

ProgressMonitor Class
ProgressMonitor Members
Overload List

Send Feedback