This article will briefly explain how to set up a simple "File Watcher/ Directory Watcher" application to run as a Windows Service using Visual Studio 2005. The coding language used is C#.
You must have a machine running Microsoft .NET Framework 2.0+.
Using the code
First, open Visual Studio.NET and create a new Windows Service project for C#:
I named this sample solution
TestCSWinWatcherService and optionally, chose to create a directory for the solution file.
Next, an appropriate reference must be added to the project as we will be using an application configuration file. Add a reference to "System.Configuration" by right-clicking on the project, then "Add Reference...":
Now, add a new Application Configuration File to the project. We will use this to define a directory (path) to "watch":
I left this named as App.config.
Within the configuration which we've just added, we will need to add an "
appSettings" section, where we'll define our directory path:
<add key="WatchPath" value="C:\\temp\\watch_directory\\" />
This should go directly below the
We can now set up our code, controls and properties for the actual service...
First, create the main
FileSystemWatcher component in the Service1.cs file. This can simply be dragged and dropped from the toolbox:
In the properties of this newly added control, change the name to something meaningful. I used
FSWatcherTest as the name. Additionally, the following properties should be set as follows:
NotifyFilter FileName, DirectoryName, Attributes, Size, LastWrite,
LastAccess, CreationTime, Security
Now that the actual control is created, switch to the code view for Service1.cs and add the code to the
OnStart() event, which gets fired when the service starts:
- Add the following reference at the top:
- Add the following code for
protected override void OnStart(string args)
FSWatcherTest.Path = ConfigurationManager.AppSettings["WatchPath"];
(Optionally, code can similarly be added to the
FileSystem events need to be set up in the
Designer code. These will trigger actions associated with file creation, deletion, etc. for the directory path that we set in our app.config file. Add the following to the Service1.designer.cs file (this should be placed right below the instantiation of the
private void FSWatcherTest_Changed(object sender,
private void FSWatcherTest_Created(object sender,
private void FSWatcherTest_Deleted(object sender,
private void FSWatcherTest_Renamed(object sender,
Add whatever code is necessary within each event, and it will get executed when the event is fired. For example, if you want to copy a file that is dropped into your defined "watch" directory, you would use something like this within the
System.IO.File.Copy(e.FullPath, "C:\\temp\\archive\\" + e.Name);
Lastly, go into the properties for Service1.cs (in design), and change the
ServiceName property to something meaningful. I used TestCSFileSysWatcher. This will be the actual name that shows up in the "Services" window in the Control Panel, once the service is installed.
The last item at hand for completion of this project is to create the windows installer class to allow the project to be compiled as a Windows service. In order to accomplish this, we must first add an InstallerClass file to our project ("Project->Add New Item..."):
(I left this file named as Installer1.cs.)
Now, we need to add two new components to the class- a
ServiceProcessInstaller installer. Drag and Drop both onto the file design. If these components are NOT located in the toolbox, simply right-click on the toolbox, and then "Choose Items.." to add them:
On the properties for
serviceInstaller1, set the
TestCSWinWatcherService. I left the
StartType property as
serviceProcessInstaller, set the
Account property to
LocalSystem. This will enable the service to be run as a local system account.
Now, simply Build
TestCSWinWatcherService (from the Build menu), and all necessary installer files will be created within the project directory. To install the newly created service, you must use the .NET Framework
InstallUtil program. I have included two batch files within this project- one to install the service, and another to UNinstall it. Each can be reused. Simply replace the
PROG variable with the name of the service that you are installing or uninstalling.