Sie sind hier: Startseite
 Liste aller Codebeispiele

Überwachung der Veränderungen in einem Verzeichnis

Ein Beispiel zum Einsatz der Klasse System.IO.FileSystemWatcher aus der .NET-Klassenbibliothek.

Autor: Dr. Holger Schwichtenberg

Beschreibung

Ein sehr schönes Feature, das es in FSO nicht gab, ist die Überwachung des Dateisystems auf Veränderungen. Überwacht werden können Dateien und Verzeichnisse. Überwachte Veränderungen sind:
  • Anlegen
  • Löschen
  • Umbenennen
  • Änderung der Dateiattribute
  • Änderung der Datumsangaben (Erstellung, Lesezugriff, Schreibzugriff)
  • Änderung der Sicherheitseinstellungen (nur unter NTFS)

Unterstützte Plattformen
Diese Dateisystemüberwachung ist nur mit Windows NT 4.0 und höher verfügbar. Die Überwachung funktioniert unter bestimmten Konstellationen auch für entfernte Laufwerke auf anderen Computern (siehe Tabelle). Die Überwachung ist natürlich nicht verfügbar für CD- und DVD-Laufwerke.
Client Festplattentyp Überwachung möglich?
Windows 2000/XP/.NET Lokale Festplatten Ja
Windows NT 4.0 Lokale Festplatten Ja
Windows 2000/XP/.NET Entfernte Festplatten unter Windows 2000/XP/.NET Ja
Windows 2000/XP/.NET Entfernte Festplatten unter Windows NT 4.0 Ja
Windows NT 4.0 Entfernte Festplatten unter Windows NT 4.0 Nein
Windows NT 4.0 Entfernte Festplatten unter Windows 2000/XP/.NET Ja
Windows 9x/ME Beliebig Nein

Klasse FileSystemWatcher
Die Überwachung wird realisiert durch eine einzige Klasse: System.IO.FileSystemWatcher. Bei der Instanziierung sind keine Parameter notwendig. Optional kann aber im ersten Parameter das zu überwachende Verzeichnis und im zweiten Parameter ein DOS-Muster für die zu überwachenden Dateien eingegeben werden.
Die Klasse FileSystemWatcher definiert vier Ereignisse, die beim Eintritt von Änderungen im Dateisystem ausgelöst werden können. Diese Ereignisse sind:
  • Changed()
  • Created()
  • Deleted()
  • Renamed()

Die Klasse bietet einige Einstellungsmöglichkeiten, um genau zu spezifizieren, was überwacht werden soll.

Eine einzelne Änderung im Dateisystem kann mehrere Ereignisse im FileSystemWatcher auslösen, z.B. führt das Ändern des Dateinamens nacheinander zu den Ereignissen Renamed und Changed. Das Verschieben einer Datei löst insgesamt fünf verschiedene Ereignisse auf der Datei und dem Zielordner aus.

Attribute
Die Klasse FileSystemWatcher erlaubt im Attribut Path die Spezifizierung, welcher Pfad überwacht werden soll.

watcher.Path = PFAD

Im Attribut Filter kann durch ein DOS-Muster (Verwendung von * und ? möglich) angegeben werden, welche Dateien überwacht werden sollen.

watcher.Filter = "*.*"

Mit IncludeSubdirectories kann festgelegt werden, dass die Überwachung auch die Unterverzeichnisse des genannten Verzeichnisses mit einschließt.

watcher.IncludeSubdirectories = True

Für das Changed-Ereignis kann näher spezifiziert werden, welche Änderungen zu beachten sind. Die folgende Tabelle zeigt die Möglichkeiten, die über die Enumeration NotifyFilters als Konstanten zur Zuweisung an das Attribut NotifyFilter zur Verfügung stehen.

Konstante Erläuterung
Attributes Änderung der Datei-/Verzeichnis-Attribute
CreationTime Änderung des Erstellungsdatums
DirectoryName Änderung des Verzeichnisnamens
FileName Änderung des Dateinamens
LastAccess Änderung des Datums des letzten Zugriffs
LastWrite Änderung des Datums des letzten Schreibzugriffs
Security Änderung der Sicherheitseinstellungen
Size Änderung der Dateigröße

Bindung der Ereignisse
Mit Hilfe des VB.NET-Befehls AddHandler müssen dann noch die Ereignisbehandlungsroutinen mit den Ereignissen verbunden werden. Es kann pro Ereignis eine Ereignisbehandlungsroutine definiert werden. Da Changed, Created und Deleted die gleichen Ereignis-Parameter besitzen, können diese drei Ereignisse auch in einer Ereignisbehandlungsroutine bearbeitet werden.

Ereignisbehandlung(ByVal source As Object, ByVal e As FileSystemEventArgs)

Im ersten Parameter wird ein Verweis auf das FileSystemWatcher-Objekt, das Auslöser war, geliefert. Der zweite Parameter, ein Objekt vom Typ FileSystemEventArgs, liefert den Pfad und den Namen der Datei bzw. des Verzeichnisses. Durch das Attribut ChangeType aus dem übergebenen FileSystemEventArgs-Objekt kann dann zwischen den drei Ereignistypen unterschieden werden.

Beim Renamed-Ereignis ist der zweite Parameter dagegen ein anderer. In der Klasse RenamedEventArgs gibt es zusätzlich die Attribute OldName und OldFullPath.

Renamed(ByVal source As Object, ByVal e As RenamedEventArgs)

Bei der Verwendung von spätem Binden können auch alle vier Ereignisse in einer Ereignisbehandlungsroutine behandelt werden. Dazu ist der zweite Parameter vom Typ System.EventArgs zu spezifizieren. Dies ist die gemeinsame Oberklasse über FileSystemEventArgs und RenamedEventArgs.

Beim Changed-Ereignis wird leider nicht übermittelt, welche Änderung ausgeführt wurde. Wenn Sie auf unterschiedliche Veränderungen anders reagieren wollen, müssen Sie dafür jeweils ein eigenes FileSystemWatcher-Objekt anlegen.

Start der Überwachung
Die Überwachung wird gestartet mit watcher.EnableRaisingEvents = True

Beispiel
Im folgenden Beispiel werden alle Ereignisse für beliebige Dateien in einem bestimmten Verzeichnis (und in dessen Unterverzeichnissen) überwacht und per Ausgabe dokumentiert.

Programmcodebeispiele Visual Basic .NET (VB.NET)

' ============================
' .NET-Code-Beispiel in Visual Basic .NET
' Überwachung der Veränderungen in einem Verzeichnis
' (C) Holger@Schwichtenberg.de
' ============================
Imports System.IO

Module Dateisystem_Ueberwachung

Public Sub Dateisystem_ueberwachen()

Const PFAD As String = "D:\data\Dateisystem"

' --- Instanziierung
Dim watcher As New FileSystemWatcher()

' --- zu überwachendes Verzeichnis
watcher.Path = PFAD
' --- zu überwachende Dateitypen
watcher.Filter = "*.*"
' --- Unterverzeichnisse einschließen
watcher.IncludeSubdirectories = True

' --- zu überwachende Änderungen
watcher.NotifyFilter = _
NotifyFilters.Attributes Or _
NotifyFilters.LastAccess Or _
NotifyFilters.LastWrite Or _
NotifyFilters.Security Or _
NotifyFilters.Size Or _
NotifyFilters.FileName Or _
NotifyFilters.DirectoryName

' --- Registrierung der
' --- Ereignisbehandlungsroutinen
AddHandler watcher.Changed, _
AddressOf DS_aenderung
AddHandler watcher.Created, AddressOf DS_neu
AddHandler watcher.Deleted, _
AddressOf DS_loeschen
AddHandler watcher.Renamed, AddressOf DS_name
' --- Starten der Überwachung
out("Überwachen von " & PFAD & " beginnt...")
watcher.EnableRaisingEvents = True
' --- Warten auf Benutzeraktion
MsgBox( _
"Klicken Sie hier, um die Überwachung " & _
"zu beenden!", , "Überwachung")

End Sub

' ### Ereignisbehandlungsroutine für
' ### Änderungsereignisse
Public Sub DSaenderung(
ByVal source As Object, _
ByVal e As FileSystemEventArgs)

out("Datei " & e.FullPath & _
" wurde geändert!")
End Sub

' ### Ereignisbehandlungsroutine für
' ### Erstellungsereignisse
Public Sub DSneu(ByVal source As Object,
ByVal e As FileSystemEventArgs)

out("Datei " & e.FullPath & _
" wurde neu angelegt!")
End Sub

' ### Ereignisbehandlungsroutine für
' ### Löschereignisse
Public Sub DSloeschen(ByVal source As Object,
ByVal e As FileSystemEventArgs)

out("Datei " & e.FullPath & _
" wurde gelöscht!")
End Sub

' ### Ereignisbehandlungsroutine für
' ### Namensänderungen im Dateisystem
Public Sub DSname(ByVal source As Object,
ByVal e As RenamedEventArgs)

out("Datei " & e.OldFullPath & _
" heißt nun " & e.FullPath & "!")
End Sub

End Module

Programmcodebeispiele CSharp (C#)

using System;
using System.IO;
using System.Windows.Forms;

using FCL_Buch;

namespace FCLBuch._SystemIO {

public class SamplesFilesystemWatcher {

public void Dateisystem_Ueberwachen() {

// Überwachung der Veränderungen in einem Verzeichnis
string pfad = @"..\daten\Dateisystem";

// Instanziierung
FileSystemWatcher watcher = new FileSystemWatcher();

// zu überwachendes Verzeichnis
watcher.Path = pfad;
// zu überwachende Dateitypen
watcher.Filter = "*.*";
// Unterverzeichnisse einschliessen
watcher.IncludeSubdirectories = true;

// zu überwachende Änderungen
watcher.NotifyFilter = NotifyFilters.Attributes | NotifyFilters.LastAccess |
NotifyFilters.LastWrite | NotifyFilters.Security | NotifyFilters.Size | NotifyFilters.FileName |
NotifyFilters.DirectoryName;

// Registrierung der Ereignisbehandlungsroutinen
watcher.Changed += new FileSystemEventHandler(watcher_Changed);
watcher.Created +=new FileSystemEventHandler(watcher_Created);
watcher.Deleted +=new FileSystemEventHandler(watcher_Deleted);
watcher.Renamed +=new RenamedEventHandler(watcher_Renamed);

// Starten der Überwachung
FclOutput.PrintOut("Überwachen von " + pfad + " beginnt...");
watcher.EnableRaisingEvents = true;

// Warten auf Benutzeraktion
MessageBox.Show("Klicken Sie hier, um die Überwachung zu beenden!", "Überwachung");
}

private void watcher_Changed(object sender, FileSystemEventArgs e) {

// Ereignisbehandlungsroutine für Änderungsereignisse
FclOutput.PrintOut( e.FullPath + " wurde geändert");
}

private void watcher_Created(object sender, FileSystemEventArgs e) {

// Ereignisbehandlungsroutine für Erstellungsereignisse
FclOutput.PrintOut( e.FullPath + " wurde neu angelegt");
}

private void watcher_Deleted(object sender, FileSystemEventArgs e) {

// Ereignisbehandlungsroutine für Löschereignisse
FclOutput.PrintOut( e.FullPath + " wurde neu angelegt");
}

private void watcher_Renamed(object sender, RenamedEventArgs e) {

// Ereignisbehandlungsroutine für Namensänderungen im Dateisystem
FclOutput.PrintOut( e.OldName + " heißt jetzt " + e.Name );
}
}
}

Hinweise

Ausgaben werden in den Beispielen durch Hilfsroutinen wie out() und PrintOut() erzeugt. Diese sind hier nicht angegeben, da deren Implementierung von der jeweiligen Umgebung abhängt. Für Konsolenanwendungen können hier z.B. Console.WriteLine() einsetzen.


 

Querverweise

 Definition '.NET Framework Class Library'  Verfügbarkeit der Klasse 'System.IO.FileSystemWatcher'  Übersicht über den FCL-Namensraum 'System.IO'  .NET & Visual Studio Community Portal

Buchtipp

Buchcover Windows PowerShell 5.1 und PowerShell Core 6.1 - Das Praxishandbuch (3. Auflage 2018/8. Auflage Gesamtreihe) Kindle Windows PowerShell 5.1 und PowerShell Core 6.1 - Das Praxishandbuch (3. Auflage 2018/8. Auflage Gesamtreihe) Kindle
Autoren: Dr. Holger Schwichtenberg
erschienen 2018, 1000 Seiten, 42,99 €
ISBN: 978-3-446-45923-6
Bestellung: Amazon.de oder im Buchhandel über ISBN 978-3-446-45923-6

Beratung & Support:

Schulungen zu diesem Thema:

 Anfrage für eine individuelle Schulung zum Thema Visual Basic;C#  Gesamter Schulungsthemenkatalog

Bücher zu diesem Thema:

 Datenbankprogrammierung mit .NET 4.0. Mit Visual Studio 2010 und SQL Server 2008 R2
 .NET 3.5
 Microsoft ASP.NET 4.0 mit C# 2010
 Webanwendungen mit ASP.NET 3.5 und AJAX Crashkurs
 Moderne Datenzugriffslösungen mit Entity Framework Core 3.1 (PDF)
 Moderne Datenzugriffslösungen mit Entity Framework Core 1.1: Datenbankprogrammierung mit .NET/.NET Core und C# (gedruckte Ausgabe)
 C# 7.3 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET Framework, .NET Core und Xamarin (PDF)
 Moderne Datenzugriffslösungen mit Entity Framework Core 1.1.1 und 2.0-Preview2: Datenbankprogrammierung mit .NET/.NET Core und C# (gedruckte Ausgabe)
 Moderne Datenzugriffslösungen mit Entity Framework Core 2.0/2.1 (Buchversion 5.x, Ebook PDF)
 Windows Scripting Lernen, 2. Auflage
 Windows 8 Apps entwickeln mit C# und XAML - Crashkurs
 Microsoft Visual C# 2010
 Moderne Datenzugriffslösungen mit Entity Framework Core 3.0 (Buchversion 6.x, Kindle)
 Microsoft SQL Server 2008 R2 - Das Entwicklerbuch
 ASP.NET 4.0 mit Visual C# 2010
 ASP.NET 4.0
 Windows PowerShell - Konzepte, Praxiseinsatz, Erweiterungen
 Microsoft .NET 2.0 Crashkurs - Final Edition
 Essential PowerShell
 Moderne Datenzugriffslösungen mit Entity Framework Core 1.1 und 2.0-Preview2 (Buchversion 1.4)
 Datenbankprogrammierung mit .NET 4.5. Mit Visual Studio 2012 und SQL Server 2012
 Moderne Datenzugriffslösungen mit Entity Framework Core 1.1 (PDF)
 Office 2010 Programmierung mit VSTO und .NET 4.0: Word, Excel und Outlook erweitern und anpassen
 ASP.NET Core Blazor 3.0/3.1: Blazor Server und Blazor Webassembly - Moderne Single-Page-Web-Applications (PDF) mit .NET, C# und Visual Studio
 Modern Data Access with Entity Framework Core: Database Programming Using .NET, .NET Core, UWP, and Xamarin with C#
 Microsoft ASP.NET 2.0 mit Visual Basic 2005 - Das Entwicklerbuch
 .NET 3.5 Crashkurs
 Windows Scripting Lernen, 6. Auflage
 Microsoft .NET 4.5 Update - Crashkurs (EBOOK - PDF)
 Visual Basic 2010: Grundlagen, ADO.NET, Windows Presentation Foundation
 C# 8.0 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET Framework, .NET Core und Xamarin (DRUCK)
 Moderne Datenzugriffslösungen mit Entity Framework Core 3.1 (DRUCK)
 Moderne Datenzugriffslösungen mit Entity Framework Core 1.1.2 und 2.0-Preview2: Datenbankprogrammierung mit .NET/.NET Core und C# (PDF)
 C# 7.3 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET Framework, .NET Core und Xamarin
 ASP.NET Core Blazor 3.0/3.1: Blazor Server und Blazor Webassembly - Moderne Single-Page-Web-Applications (DRUCK) mit .NET, C# und Visual Studio
 Microsoft ASP.NET 2.0 mit C# 2005 - Das Entwicklerbuch
 Effizienter Datenzugriff mit Entity Framework Core: Datenbankprogrammierung mit C# für .NET Framework, .NET Core und Xamarin
 Microsoft ASP.NET 3.5 mit Visual C# 2008 - Das Entwicklerbuch
 Einblicke in C# 6.0 (shortcuts 181) Kindle Edition
 .NET 4.0 Crashkurs
 Docker und die Containerwelt - Einstieg und Expertentipps rund um Docker-Container (shortcut)
 Microsoft .NET 4.5 Update - Crashkurs
 ASP.NET Core Blazor 3.0/3.1: Blazor Server und Blazor Webassembly - Moderne Single-Page-Web-Applications mit .NET, C# und Visual Studio
 Moderne Datenzugriffslösungen mit Entity Framework Core 3.0 (Buchversion 6.x, Gedruckt)
 Moderne Webanwendungen für .NET-Entwickler: Server-Anwendungen, Web APIs, SPAs & HTML-Cross-Platform-Anwendungen mit ASP.NET, ASP.NET Core, JavaScript/TypeScript und Angular
 C# 7.2 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET Framework, .NET Core und Xamarin (PDF)
 Moderne Datenzugriffslösungen mit Entity Framework Core 3.1 (Kindle)
 Moderne Datenzugriffslösungen mit Entity Framework 6 (gedruckte Ausgabe)
 C# 7.3 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET Framework, .NET Core und Xamarin (DRUCK)
 Moderne Datenzugriffslösungen mit Entity Framework Core 1.x und 2.0: Datenbankprogrammierung mit .NET/.NET Core und C# (gedruckte Ausgabe)
 Visual Basic 2010
 Microsoft ASP.NET 4.5 mit C# 2012 - Entwicklerbuch
 Microsoft ASP.NET 3.5 mit Visual Basic 2008 - Das Entwicklerbuch
 Moderne Datenzugriffslösungen mit Entity Framework Core 3.0 (Buchversion 7.x, PDF)
 Windows Scripting (5. Auflage)
 C# 8.0 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET Framework, .NET Core und Xamarin (PDF)
 Moderne Datenzugriffslösungen mit Entity Framework Core 2.0 (Buchversion 4.x): Datenbankprogrammierung mit .NET/.NET Core und C# (gedruckte Ausgabe)
 Moderne Datenzugriffslösungen mit Entity Framework Core 2.0 (Buchversion 4.x): Datenbankprogrammierung mit .NET/.NET Core und C# (EBOOK - PDF)
 Moderne Datenzugriffslösungen mit Entity Framework 6 (EBOOK - PDF, MOBI, EPUB)
 C# 8.0 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET Framework, .NET Core und Xamarin
 Moderne Datenzugriffslösungen mit Entity Framework Core 1.x und 2.0: Datenbankprogrammierung mit .NET/.NET Core und C# (EBOOK - PDF)
 Windows Scripting Lernen 5. Auflage
 Alle unsere aktuellen Fachbücher