UpdateProgressAndCheckCancelled Method

In This Topic

Updates the progress bar value and checks if the worker thread has been canceled.

Syntax

Visual Basic
C#

'Declaration
 
Protected Friend Function UpdateProgressAndCheckCancelled( _
   ByVal current As Integer, _
   ByVal total As Integer, _
   ByVal text As String, _
   ByVal worker As BackgroundWorker, _
   ByVal doWorkEventArgs As DoWorkEventArgs, _
   Optional ByVal forceUpdate As Boolean _
) As Boolean

protected internal bool UpdateProgressAndCheckCancelled( 
   int current,
   int total,
   string text,
   BackgroundWorker worker,
   DoWorkEventArgs doWorkEventArgs,
   bool forceUpdate
)

Parameters

current: The current step
total: The total number of steps
text: The progress bar text
worker: The background worker thread
doWorkEventArgs: DoWork event arguments
forceUpdate: When true the event is always fired. Must be used with caution!

Return Value

False if the worker thread was canceled, true otherwise.

Reference

WorkUnit Class
WorkUnit Members

Send Feedback