FileSystemWatcher.Filter Propriété

Définition

Espace de noms:

System.IO

Assemblys:

netstandard.dll, System.IO.FileSystem.Watcher.dll

Source:

FileSystemWatcher.cs

Obtient ou définit la chaîne de filtre utilisée pour déterminer les fichiers surveillés dans un répertoire.

public:
 property System::String ^ Filter { System::String ^ get(); void set(System::String ^ value); };

public string Filter { get; set; }

member this.Filter : string with get, set

Public Property Filter As String

Valeur de propriété

String

Chaîne de filtre. La valeur par défaut est « *.* » (Surveille tous les fichiers.)

Exemples

L’exemple suivant crée un FileSystemWatcher répertoire pour regarder le répertoire spécifié au moment de l’exécution. Le composant est défini pour surveiller les modifications dans LastWrite le LastAccess temps, la création, la suppression ou le renommage des fichiers texte dans le répertoire. Si un fichier est modifié, créé ou supprimé, le chemin d’accès au fichier s’imprime dans la console. Lorsqu’un fichier est renommé, les anciens chemins d’accès s’impriment dans la console.

using System;
using System.IO;

namespace MyNamespace
{
    class MyClassCS
    {
        static void Main()
        {
            using var watcher = new FileSystemWatcher(@"C:\path\to\folder");

            watcher.NotifyFilter = NotifyFilters.Attributes
                                 | NotifyFilters.CreationTime
                                 | NotifyFilters.DirectoryName
                                 | NotifyFilters.FileName
                                 | NotifyFilters.LastAccess
                                 | NotifyFilters.LastWrite
                                 | NotifyFilters.Security
                                 | NotifyFilters.Size;

            watcher.Changed += OnChanged;
            watcher.Created += OnCreated;
            watcher.Deleted += OnDeleted;
            watcher.Renamed += OnRenamed;
            watcher.Error += OnError;

            watcher.Filter = "*.txt";
            watcher.IncludeSubdirectories = true;
            watcher.EnableRaisingEvents = true;

            Console.WriteLine("Press enter to exit.");
            Console.ReadLine();
        }

        private static void OnChanged(object sender, FileSystemEventArgs e)
        {
            if (e.ChangeType != WatcherChangeTypes.Changed)
            {
                return;
            }
            Console.WriteLine($"Changed: {e.FullPath}");
        }

        private static void OnCreated(object sender, FileSystemEventArgs e)
        {
            string value = $"Created: {e.FullPath}";
            Console.WriteLine(value);
        }

        private static void OnDeleted(object sender, FileSystemEventArgs e) =>
            Console.WriteLine($"Deleted: {e.FullPath}");

        private static void OnRenamed(object sender, RenamedEventArgs e)
        {
            Console.WriteLine($"Renamed:");
            Console.WriteLine($"    Old: {e.OldFullPath}");
            Console.WriteLine($"    New: {e.FullPath}");
        }

        private static void OnError(object sender, ErrorEventArgs e) =>
            PrintException(e.GetException());

        private static void PrintException(Exception? ex)
        {
            if (ex != null)
            {
                Console.WriteLine($"Message: {ex.Message}");
                Console.WriteLine("Stacktrace:");
                Console.WriteLine(ex.StackTrace);
                Console.WriteLine();
                PrintException(ex.InnerException);
            }
        }
    }
}

Imports System.IO

Namespace MyNamespace

    Class MyClassVB

        Shared Sub Main()
            Using watcher = New FileSystemWatcher("C:\path\to\folder")
                watcher.NotifyFilter = NotifyFilters.Attributes Or
                                       NotifyFilters.CreationTime Or
                                       NotifyFilters.DirectoryName Or
                                       NotifyFilters.FileName Or
                                       NotifyFilters.LastAccess Or
                                       NotifyFilters.LastWrite Or
                                       NotifyFilters.Security Or
                                       NotifyFilters.Size

                AddHandler watcher.Changed, AddressOf OnChanged
                AddHandler watcher.Created, AddressOf OnCreated
                AddHandler watcher.Deleted, AddressOf OnDeleted
                AddHandler watcher.Renamed, AddressOf OnRenamed
                AddHandler watcher.Error, AddressOf OnError

                watcher.Filter = "*.txt"
                watcher.IncludeSubdirectories = True
                watcher.EnableRaisingEvents = True

                Console.WriteLine("Press enter to exit.")
                Console.ReadLine()
            End Using
        End Sub

        Private Shared Sub OnChanged(sender As Object, e As FileSystemEventArgs)
            If e.ChangeType <> WatcherChangeTypes.Changed Then
                Return
            End If
            Console.WriteLine($"Changed: {e.FullPath}")
        End Sub

        Private Shared Sub OnCreated(sender As Object, e As FileSystemEventArgs)
            Dim value As String = $"Created: {e.FullPath}"
            Console.WriteLine(value)
        End Sub

        Private Shared Sub OnDeleted(sender As Object, e As FileSystemEventArgs)
            Console.WriteLine($"Deleted: {e.FullPath}")
        End Sub

        Private Shared Sub OnRenamed(sender As Object, e As RenamedEventArgs)
            Console.WriteLine($"Renamed:")
            Console.WriteLine($"    Old: {e.OldFullPath}")
            Console.WriteLine($"    New: {e.FullPath}")
        End Sub

        Private Shared Sub OnError(sender As Object, e As ErrorEventArgs)
            PrintException(e.GetException())
        End Sub

        Private Shared Sub PrintException(ex As Exception)
            If ex IsNot Nothing Then
                Console.WriteLine($"Message: {ex.Message}")
                Console.WriteLine("Stacktrace:")
                Console.WriteLine(ex.StackTrace)
                Console.WriteLine()
                PrintException(ex.InnerException)
            End If
        End Sub

    End Class

End Namespace

Remarques

Pour surveiller les modifications apportées à tous les fichiers, définissez la Filter propriété sur une chaîne vide ( » « ). Pour surveiller un fichier spécifique, définissez la Filter propriété sur le nom du fichier. Par exemple, pour surveiller les modifications apportées au fichier MyDoc.txt, définissez la Filter propriété sur «MyDoc.txt». Vous pouvez également surveiller les modifications apportées à un certain type de fichier. Par exemple, pour surveiller les modifications apportées aux fichiers texte, définissez la Filter propriété sur « *.txt». L’utilisation de plusieurs filtres tels que « *.txt|*.doc » n’est pas prise en charge.

La Filter propriété peut être modifiée une fois que l’objet FileSystemWatcher a commencé à recevoir des événements.

Pour plus d’informations sur le filtrage des notifications indésirables, consultez les propriétés et InternalBufferSizeIncludeSubdirectoriesles NotifyFilterpropriétés.

Filter accepte des caractères génériques pour les fichiers correspondants, comme indiqué dans les exemples suivants.

Chaîne de filtre	Surveille les fichiers suivants
*.*	Tous les fichiers (par défaut). Une chaîne vide («  ») surveille également tous les fichiers.
*.txt	Tous les fichiers avec une extension « txt ».
*recipe.doc	Tous les fichiers se terminant par « recette » avec une extension « doc ».
win*.xml	Tous les fichiers commençant par « win » avec une extension « xml ».
Ventes*200 ?.xls	Correspond à ce qui suit : - Ventes 2001.xls juillet - Ventes d’août 2002.xls - Ventes mars 2004.xls mais ne correspond pas à : - Ventes 1999.xls
MyReport.Doc	Montres uniquement MyReport.doc

Voir aussi

• NotifyFilter
• IncludeSubdirectories
• InternalBufferSize