Article Options
Recently Viewed
Premium Sponsor
Premium Sponsor

 »  Home  »  .NET Framework  »  Framework 2.0  »  Multithreading The Easy Way: The BackgroundWorker
 »  Home  »  .NET Framework  »  Framework 3.0  »  Multithreading The Easy Way: The BackgroundWorker
 »  Home  »  .NET Intermediate  »  Multithreading The Easy Way: The BackgroundWorker
 »  Home  »  Visual Studio 2005  »  Multithreading The Easy Way: The BackgroundWorker
 »  Home  »  Visual Studio 2008  »  Multithreading The Easy Way: The BackgroundWorker
 »  Home  »  Windows Development  »  Visual Basic 2005  »  Multithreading The Easy Way: The BackgroundWorker
 »  Home  »  Windows Development  »  Windows Presentation Foundation  »  Multithreading The Easy Way: The BackgroundWorker
Multithreading The Easy Way: The BackgroundWorker
by Ged Mead | Published  06/01/2008 | Framework 2.0 Framework 3.0 .NET Intermediate Visual Studio 2005 Visual Studio 2008 Visual Basic 2005 Windows Presentation Foundation | Rating:
Ged Mead

Ged Mead (XTab) is a Microsoft Visual Basic MVP who has been working on computer software and design for more than 25 years. His journey has taken him through many different facets of IT. These include training as a Systems Analyst, working in a mainframe software development environment, creating financial management systems and a short time spent on military laptop systems in the days when it took two strong men to carry a 'mobile' system.

Based in an idyllic lochside location in the West of Scotland, he is currently involved in an ever-widening range of VB.NET, WPF and Silverlight development projects. Now working in a consultancy environment, his passion however still remains helping students and professional developers to take advantage of the ever increasing range of sophisticated tools available to them.

Ged is a regular contributor to forums on vbCity and authors articles for DevCity. He is a moderator on VBCity and the MSDN Tech Forums and spends a lot of time answering technical questions there and in several other VB forum sites. Senior Editor for DevCity.NET, vbCity Developer Community Leader and Admin, and DevCity.NET Newsletter Editor. He has written and continues to tutor a number of free online courses for VB.NET developers.

 

View all articles by Ged Mead...
The Task

Introduction
  This article came about because I had seen several posts on vbCity recently where I thought the best approach might be to use a BackgroundWorker.  As you probably know, this is a helper component that wraps away some of the down-and-dirty stuff you need if you want to use multithreading. The BackgroundWorker won't meet every possible scenario where you have to get stuck into multithreading, but it's a very useful little tool in many basic situations.

  For this example I am going to run a slow, somewhat resource intensive process on a background thread and will test that it is working as it should by making another form containing other controls available to the user while the slow background task is running.

  The actual task is a (kinda) real world one where the code makes a search for specific files  in directories on a user's hard drive.   Just for interest I have extended this basic scenario so that files that match a particular file type (e.g. text files) are further searched to see if they contain a specific string.

  This makes it a potentially long running task and therefore one that is very suitable to carry out on a separate asynchronous thread; the result being that the user can continue to use other parts of the application without the whole thing hanging while the searches take place.

  The code below is the skeleton of the background task:  

Code Copy
  Sub FileFinder(ByVal dir As String)
        Try
            ' Display all files in a directory that match file type
            For Each fname As String In Directory.GetFiles(dir)
        If fname.EndsWith("txt") Then
                    'TODO:  pass back progress message
              End If
            Next
           ' A recursive call for all the subdirectories in this directory.
            For Each subdir As String In Directory.GetDirectories(dir)
                FileFinder(subdir)
            Next
        Catch ex As Exception
            MessageBox.Show(ex.Message.ToString)
        End Try
    End Sub


Comments    Submit Comment

Comment #1  (Posted by an unknown user on 06/04/2008)
Rating
Very clear and easy to follow. AND the sample Worked!!!!
 
Comment #2  (Posted by RAB on 06/12/2008)
Rating
Can we use teh Backgroundworker component without a form? Can it be instantiated in a module?
 
Comment #3  (Posted by Ged Mead on 06/20/2008)
Rating
Yes you can do that. However as there is no toolbox available for a Module you have to create the bgw in code. To do this you use Dim bgw as New System.ComponentModel.BackgroundWorker.
You will of course also need to set the properties and add handlers in code.
If you need more info on this question please post a question in the vbcity VB.NET forums (where it's easier for me to post code samples) :-}
 
Comment #4  (Posted by an unknown user on 07/30/2008)
Rating
Thank a lot XTab
 
Comment #5  (Posted by an unknown user on 08/08/2008)
Rating
Great step-by-step with in-line code. Ged obviously put alot of time in this well written article.
More please !
 
Comment #6  (Posted by an unknown user on 08/13/2008)
Rating
I try to read everything you publish. Great stuff.
 
Comment #7  (Posted by an unknown user on 08/18/2008)
Rating
Excellent and simple to use.
 
Comment #8  (Posted by an unknown user on 09/06/2008)
Rating
practical, readable
 
Comment #9  (Posted by an unknown user on 09/29/2008)
Rating
This guide was one of the best guides I've read!

You just helped me understand something I origionally had no clue about. Thanks!
 
Comment #10  (Posted by Matt Higginbotham on 10/31/2008)
Rating
Thanks Ged! What a great article.. This helped me a bunch with some long database queries that i have.

Keep Em' Coming
 
Comment #11  (Posted by an unknown user on 11/03/2008)
Rating
Very good except the cancelation did not work correctly, although it cancelled the task if I cancelled it and then re-ran I got "Operation has already had OperationCanceled called on it". I need to reset the canelled property at finish but, its read only any ideas?
 
Comment #12  (Posted by an unknown user on 12/01/2008)
Rating
eltroeralboc
 
Comment #13  (Posted by an unknown user on 12/12/2008)
Rating
Eays to understand. Right to the point, with some sence of humor.
Thank you.
 
Comment #14  (Posted by an unknown user on 12/21/2008)
Rating
very good... this is what i'm searching for.
 
Comment #15  (Posted by Jimbo on 12/28/2008)
Rating
What if I want the backgroundworker to KEEP working, and watch the folder for changes? Do I just put a loop in the Sub bWkrFileCheck_DoWork, this might just keep populating the window over and over though :-) Thanks in advance, this is great stuff!
 
Comment #16  (Posted by an unknown user on 12/29/2008)
Rating
Great article! Answered many of my basic questions about how to use that control.
 
Comment #17  (Posted by busrider on 01/04/2009)
Rating
eFront-???????? ??????? ??????? ? ???????????? ??????? www.e-front.com.ua
 
Comment #18  (Posted by an unknown user on 02/14/2009)
Rating
Great conceptual explanations and screenshots. I didn't see a single file that had all the code together. Even through my jumping around (adapting it to VB Express), I could still follow both the details and the general direction of the project. Great job!
 
Comment #19  (Posted by an unknown user on 03/27/2009)
Rating
I am relatively new to coding, and backgroundworker is a leap for me. This great article makes it possible to understand how each part of bkwkr works together. The one thing, for my project, I can't seem to do is to make it so that only the file names list in the listbox instead of the whole path. I've done this plenty of times before but for some reason no place I'm trying to do this is giving me anything other than the directory folder (above the files) listed multiple times. Not the file names themselves. Any ideas?
 
Comment #20  (Posted by Ged Mead on 03/28/2009)
Rating
If you use my sample code, at the point where the variable 'fname' is used to pass the full path to the listbox, change this to a new string. You can strip out the path from fname by using LastIndexOf, with the backslash as the argument. Then you can pull out the chars from the last backslash to the end of the path (i.e the file name only). Finally you hand this shortened string back to fname. Hope this helps.
 
Comment #21  (Posted by Gerald Grenade on 04/17/2009)
Rating
I have to agree with everyone here and thank you for this excellent presentation - I have been browsing the net and read 5 books in Visual basic - Never found a topic so cleary explained - Just wanted to know if you have covered something regarding threading - I am planning to do some serial com and i want to update a form - but i get cross thread error because i am trying to access a form control from another thread that instantiated it - the background worker method is a solution - if you have some times .. Thanks again for the excellent write up - i look foreward to see other posts from you
 
Comment #22  (Posted by an unknown user on 05/11/2009)
Rating
I am newbie to VB. Ur articles hav helped me a lot, they are just they way i wanted ....Thanks :):)
 
Comment #23  (Posted by an unknown user on 06/11/2009)
Rating
Gave me the exact information I needed to perform lengthy processes.
 
Comment #24  (Posted by Onur on 08/06/2009)
Rating
Dear Ged,

Very good article of you, however i want to express something about experiments related to Backgroundworker. Though Backgroundworker provides us an easy way to run more than one task at the same time, if you have a CPU-intensive job, the UI may get blocked or the UI (form) may not be moved or minimized because of not being able to process messages due to %100 CPU consumtion.

For example, on my crappy p4 2.4 single-core machine, you cannot move window while task is in progress:

Private Sub bgworker1_DoWork(ByVal sender As System.Object, ByVal e As System.ComponentModel.DoWorkEventArgs) Handles bgworker1.DoWork
For x As Integer = 0 To 50000
bgworker1.ReportProgress(x)
Threading.Thread.Sleep(1)
Next
End Sub

Private Sub bgworker1_pchanged(ByVal sender As System.Object, ByVal e As System.ComponentModel.ProgressChangedEventArgs) Handles bgworker1.ProgressChanged
Label1.Text = e.ProgressPercentage

End Sub

Private Sub bgworker1_finished(ByVal sender As System.Object, ByVal e As System.ComponentModel.RunWorkerCompletedEventArgs) Handles bgworker1.RunWorkerCompleted
Label2.Text = "Done!"

End Sub

Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click
Label1.Text = "Waiting.."

bgworker1.RunWorkerAsync()
End Sub

The only chance to move form, is to use Sleep to let Windows process move message:

' In DoWork Event:

Private Sub bgworker1_DoWork(ByVal sender As System.Object, ByVal e As System.ComponentModel.DoWorkEventArgs) Handles bgworker1.DoWork
For x As Integer = 0 To 50000
bgworker1.ReportProgress(x)
' One milisecond is enough on my machine
Threading.Thread.Sleep(1)
Next
End Sub

However, on some powerful multi-core CPU-having PCs, it may not be required to pause execution to let CPU breathe for a milisecond.

Just my point of view,

Hope you reply,

Onur
 
Comment #25  (Posted by Onur on 08/06/2009)
Rating
Related to my provius comment, i meant "i cannot move form" while task is in progress (counting) if i don't use Thread.Sleep in DoWork event of BGW due to %100 cpu usage on my old P4 2.4 GHZ machine. So, you can test it by omitting "Thread.Sleep" in the code i've previously posted.

Thanks.

Onur
 
Comment #26  (Posted by an unknown user on 08/08/2009)
Rating
Great for Windows apps. Is there also a good example of how to get this to work with web apps in VB.NET?
 
Comment #27  (Posted by on 10/11/2009)
Rating

 
Comment #28  (Posted by an unknown user on 10/26/2009)
Rating
Explained the BackgroundWorker multithreading Class in a straightforward and easy to follow manner. Excellent for the newcomer to multithreading.
 
Comment #29  (Posted by an unknown user on 10/29/2009)
Rating
It contained everything I was looking for in an easy to understand way..
 
Comment #30  (Posted by an unknown user on 10/31/2009)
Rating
Easy to follow!
 
Comment #31  (Posted by myintnaing on 11/04/2009)
Rating
I am IT Student

 
Comment #32  (Posted by Of these, M1 is the most significant since on 11/24/2009)
Rating
I really do like this place.: URLsWithNothing
 
Sponsored Links