FileSystemWatcher.Filter Свойство

Определение

Пространство имен:

System.IO

Сборки:

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

Исходный код:

FileSystemWatcher.cs

Возвращает или задает строку фильтра, используемую для определения файлов, отслеживаемых в каталоге.

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

Значение свойства

String

Строка фильтра. Значение по умолчанию — "*.*" (Просматривает все файлы.)

Примеры

В следующем примере создается FileSystemWatcher каталог, указанный во время выполнения. Компонент устанавливается для отслеживания изменений и LastWriteLastAccess времени, создания, удаления или переименования текстовых файлов в каталоге. Если файл изменен, создан или удален, путь к файлу выводится в консоль. При переименовании файла старые и новые пути печатаются в консоли.

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

Комментарии

Чтобы просмотреть изменения во всех файлах, задайте Filter для свойства пустую строку (""). Чтобы следить за определенным файлом, установите свойство Filter на имя файла. Например, чтобы отслеживать изменения в файле MyDoc.txt, задайте Filter для свойства значение "MyDoc.txt". Вы также можете отслеживать изменения в определенном типе файла. Например, чтобы отслеживать изменения в текстовых файлах, задайте Filter для свойства значение "*.txt". Использование нескольких фильтров, таких как "*.txt|*.doc", не поддерживается.

Свойство Filter можно изменить после FileSystemWatcher начала получения событий объекта.

Дополнительные сведения о фильтрации нежелательных уведомлений см. в разделе NotifyFilterо свойствах и InternalBufferSize свойствахIncludeSubdirectories.

Filter принимает подстановочные знаки для соответствующих файлов, как показано в следующих примерах.

Строка фильтра	Просмотр следующих файлов
*.*	Все файлы (по умолчанию). Пустая строка ("") также проверяет все файлы.
*.txt	Все файлы с расширением txt.
*recipe.doc	Все файлы, заканчивающиеся на "рецепт" с расширением doc.
win*.xml	Все файлы, начиная с "win", с расширением "xml".
Продажи*200?.xls	Соответствует следующим: - Продажи 2001.xls июля - Продажи за август 2002.xls - Продажи март 2004.xls но не соответствует: - Продажи ноябрь 1999.xls
MyReport.Doc	Часы только MyReport.doc

См. также раздел

• NotifyFilter
• IncludeSubdirectories
• InternalBufferSize