FileSystemWatcher Класс

Определение

public ref class FileSystemWatcher : System::ComponentModel::Component, System::ComponentModel::ISupportInitialize

public ref class FileSystemWatcher : IDisposable

public ref class FileSystemWatcher : System::ComponentModel::Component, IDisposable, System::ComponentModel::ISupportInitialize

public class FileSystemWatcher : System.ComponentModel.Component, System.ComponentModel.ISupportInitialize

public class FileSystemWatcher : IDisposable

[System.IO.IODescription("FileSystemWatcherDesc")]
public class FileSystemWatcher : System.ComponentModel.Component, System.ComponentModel.ISupportInitialize

public class FileSystemWatcher : System.ComponentModel.Component, IDisposable, System.ComponentModel.ISupportInitialize

[System.IO.IODescription("")]
public class FileSystemWatcher : System.ComponentModel.Component, System.ComponentModel.ISupportInitialize

type FileSystemWatcher = class
    inherit Component
    interface ISupportInitialize

type FileSystemWatcher = class
    interface IDisposable

[<System.IO.IODescription("FileSystemWatcherDesc")>]
type FileSystemWatcher = class
    inherit Component
    interface ISupportInitialize

type FileSystemWatcher = class
    inherit Component
    interface IDisposable
    interface ISupportInitialize

[<System.IO.IODescription("")>]
type FileSystemWatcher = class
    inherit Component
    interface ISupportInitialize

Public Class FileSystemWatcher
Inherits Component
Implements ISupportInitialize

Public Class FileSystemWatcher
Implements IDisposable

Public Class FileSystemWatcher
Inherits Component
Implements IDisposable, ISupportInitialize

Наследование

Object

MarshalByRefObject

Component

FileSystemWatcher

Наследование

Object

FileSystemWatcher

Атрибуты

IODescriptionAttribute

Реализации

ISupportInitialize IDisposable

Примеры

В следующем примере создается объект FileSystemWatcher для отслеживания каталога, указанного во время выполнения.The following example creates a FileSystemWatcher to watch the directory specified at run time. Компонент настроен для отслеживания изменений в LastWrite и LastAccess времени, создания, удаления или переименования текстовых файлов в каталоге.The component is set to watch for changes in LastWrite and LastAccess time, the creation, deletion, or renaming of text files in the directory. Если файл был изменен, создан или удален, путь к файлу выводится на консоль.If a file is changed, created, or deleted, the path to the file prints to the console. При переименовании файла старый и новый пути выводятся на консоль.When a file is renamed, the old and new paths print to the console.

#include "pch.h"

using namespace System;
using namespace System::IO;

class MyClassCPP
{
public:

    int static Run()
    {
        FileSystemWatcher^ watcher = gcnew FileSystemWatcher("C:\\path\\to\\folder");

        watcher->NotifyFilter = static_cast<NotifyFilters>(NotifyFilters::Attributes
                                                         | NotifyFilters::CreationTime
                                                         | NotifyFilters::DirectoryName
                                                         | NotifyFilters::FileName
                                                         | NotifyFilters::LastAccess
                                                         | NotifyFilters::LastWrite
                                                         | NotifyFilters::Security
                                                         | NotifyFilters::Size);

        watcher->Changed += gcnew FileSystemEventHandler(MyClassCPP::OnChanged);
        watcher->Created += gcnew FileSystemEventHandler(MyClassCPP::OnCreated);
        watcher->Deleted += gcnew FileSystemEventHandler(MyClassCPP::OnDeleted);
        watcher->Renamed += gcnew RenamedEventHandler(MyClassCPP::OnRenamed);
        watcher->Error   += gcnew ErrorEventHandler(MyClassCPP::OnError);

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

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

        return 0;
    }

private:

    static void OnChanged(Object^ sender, FileSystemEventArgs^ e)
    {
        if (e->ChangeType != WatcherChangeTypes::Changed)
        {
            return;
        }
        Console::WriteLine("Changed: {0}", e->FullPath);
    }

    static void OnCreated(Object^ sender, FileSystemEventArgs^ e)
    {
        Console::WriteLine("Created: {0}", e->FullPath);
    }

    static void OnDeleted(Object^ sender, FileSystemEventArgs^ e)
    {
        Console::WriteLine("Deleted: {0}", e->FullPath);
    }

    static void OnRenamed(Object^ sender, RenamedEventArgs^ e)
    {
        Console::WriteLine("Renamed:");
        Console::WriteLine("    Old: {0}", e->OldFullPath);
        Console::WriteLine("    New: {0}", e->FullPath);
    }

    static void OnError(Object^ sender, ErrorEventArgs^ e)
    {
        PrintException(e->GetException());
    }

    static void PrintException(Exception^ ex)
    {
        if (ex != nullptr)
        {
            Console::WriteLine("Message: {0}", ex->Message);
            Console::WriteLine("Stacktrace:");
            Console::WriteLine(ex->StackTrace);
            Console::WriteLine();
            PrintException(ex->InnerException);
        }
    }
};


int main()
{
    MyClassCPP::Run();
}

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

Комментарии

Используется FileSystemWatcher для отслеживания изменений в указанном каталоге.Use FileSystemWatcher to watch for changes in a specified directory. Вы можете отслеживать изменения в файлах и подкаталогах указанного каталога.You can watch for changes in files and subdirectories of the specified directory. Можно создать компонент для просмотра файлов на локальном компьютере, на сетевом диске или на удаленном компьютере.You can create a component to watch files on a local computer, a network drive, or a remote computer.

Чтобы отслеживать изменения во всех файлах, присвойте Filter свойству пустую строку ("") или используйте подстановочные знаки ("*. * ").To watch for changes in all files, set the Filter property to an empty string ("") or use wildcards ("*.*"). Чтобы просмотреть конкретный файл, присвойте Filter свойству имя файла.To watch a specific file, set the Filter property to the file name. Например, чтобы отслеживать изменения в файле MyDoc.txt, задайте Filter для свойства значение "MyDoc.txt".For example, to watch for changes in the file MyDoc.txt, set the Filter property to "MyDoc.txt". Кроме того, можно отслеживать изменения в файле определенного типа.You can also watch for changes in a certain type of file. Например, чтобы отслеживать изменения в текстовых файлах, задайте Filter для свойства значение " * . txt".For example, to watch for changes in text files, set the Filter property to "*.txt".

Существует несколько типов изменений, которые можно отслеживать в каталоге или файле.There are several types of changes you can watch for in a directory or file. Например, можно отслеживать изменения в Attributes , LastWrite дату и время, а также Size файлы или каталоги.For example, you can watch for changes in Attributes, the LastWrite date and time, or the Size of files or directories. Это можно сделать, задав NotifyFilter для свойства одно из NotifyFilters значений.This is done by setting the NotifyFilter property to one of the NotifyFilters values. Дополнительные сведения о типе изменений, которые можно отслеживать, см. в разделе NotifyFilters .For more information on the type of changes you can watch, see NotifyFilters.

Вы можете отслеживать переименование, удаление или создание файлов или каталогов.You can watch for renaming, deletion, or creation of files or directories. Например, чтобы отслеживать переименование текстовых файлов, задайте для свойства значение Filter "*. txt" и вызовите WaitForChanged метод с Renamed заданным для его параметра.For example, to watch for renaming of text files, set the Filter property to "*.txt" and call the WaitForChanged method with a Renamed specified for its parameter.

Операционная система Windows уведомляет компонент об изменениях файлов в буфере, созданном FileSystemWatcher .The Windows operating system notifies your component of file changes in a buffer created by the FileSystemWatcher. Если в течение короткого промежутка времени произошло много изменений, буфер может переполниться.If there are many changes in a short time, the buffer can overflow. В результате компонент теряет возможность отслеживания изменений в каталоге и предоставит только общие уведомления.This causes the component to lose track of changes in the directory, and it will only provide blanket notification. Увеличение размера буфера с помощью InternalBufferSize свойства является дорогостоящим, так как оно поступает из нестраничной памяти, которое не может быть переключено на диск, поэтому размер буфера должен быть небольшим, достаточно большим, чтобы не пропускать события изменения файла.Increasing the size of the buffer with the InternalBufferSize property is expensive, as it comes from non-paged memory that cannot be swapped out to disk, so keep the buffer as small yet large enough to not miss any file change events. Чтобы избежать переполнения буфера, используйте NotifyFilter Свойства и, IncludeSubdirectories чтобы можно было отфильтровать ненужные уведомления об изменениях.To avoid a buffer overflow, use the NotifyFilter and IncludeSubdirectories properties so you can filter out unwanted change notifications.

Список начальных значений свойств для экземпляра FileSystemWatcher см. в разделе FileSystemWatcher конструктор.For a list of initial property values for an instance of FileSystemWatcher, see the FileSystemWatcher constructor.

При использовании класса Обратите внимание на следующее FileSystemWatcher .Please note the following when using the FileSystemWatcher class.

• Скрытые файлы не пропускаются.Hidden files are not ignored.

• В некоторых системах FileSystemWatcher отчеты изменяются в файлах с использованием краткого формата имени файла 8,3.In some systems, FileSystemWatcher reports changes to files using the short 8.3 file name format. Например, изменение "Лонгфиленаме. Лонжекстенсион" может быть получено как "Лонгфил ~. Долгота ".For example, a change to "LongFileName.LongExtension" could be reported as "LongFil~.Lon".

• Этот класс содержит требования связывания и наследования на уровне класса, которые применяются ко всем элементам.This class contains a link demand and an inheritance demand at the class level that applies to all members. Если непосредственно вызывающий оператор или производный класс не имеет разрешения полного доверия, возникает исключение SecurityException.A SecurityException is thrown when either the immediate caller or the derived class does not have full-trust permission. Дополнительные сведения о требованиях безопасности см. в разделе Требования связывания.For details about security demands, see Link Demands.

• Максимальный размер, который можно задать для InternalBufferSize свойства для мониторинга каталога по сети, — 64 КБ.The maximum size you can set for the InternalBufferSize property for monitoring a directory over the network is 64 KB.

Копирование и перемещение папокCopying and moving folders

Операционная система и FileSystemWatcher объект обрабатывают действие вырезания и вставки или действие перемещения как действие переименования для папки и ее содержимого.The operating system and FileSystemWatcher object interpret a cut-and-paste action or a move action as a rename action for a folder and its contents. Если вырезать и вставить папку с файлами в отслеживаемую папку, FileSystemWatcher объект будет сообщать только о новой папке, но не ее содержимом, так как они, по сути, только переименованы.If you cut and paste a folder with files into a folder being watched, the FileSystemWatcher object reports only the folder as new, but not its contents because they are essentially only renamed.

Чтобы получать уведомления о том, что содержимое папок было перемещено или скопировано в отслеживаемую папку, укажите OnChanged OnRenamed методы и обработчики событий, как описано в следующей таблице.To be notified that the contents of folders have been moved or copied into a watched folder, provide OnChanged and OnRenamed event handler methods as suggested in the following table.

События и размеры буферовEvents and Buffer Sizes

Обратите внимание, что некоторые факторы могут влиять на то, какие события изменения файловой системы вызываются, как описано ниже:Note that several factors can affect which file system change events are raised, as described by the following:

• Общие операции файловой системы могут вызвать более одного события.Common file system operations might raise more than one event. Например, при перемещении файла из одного каталога в другой OnChanged могут возникать несколько и некоторые OnCreated OnDeleted события.For example, when a file is moved from one directory to another, several OnChanged and some OnCreated and OnDeleted events might be raised. Перемещение файла — это сложная операция, состоящая из нескольких простых операций, в результате чего вызывается несколько событий.Moving a file is a complex operation that consists of multiple simple operations, therefore raising multiple events. Аналогичным образом, некоторые приложения (например, антивирусная программа) могут вызвать дополнительные события файловой системы, обнаруженные FileSystemWatcher .Likewise, some applications (for example, antivirus software) might cause additional file system events that are detected by FileSystemWatcher.

• FileSystemWatcherМожет просматривать диски, если они не переключаются или не удаляются.The FileSystemWatcher can watch disks as long as they are not switched or removed. Не FileSystemWatcher создает события для компакт-дисков и DVD-дисков, так как метки времени и свойства не могут изменяться.The FileSystemWatcher does not raise events for CDs and DVDs, because time stamps and properties cannot change. Для правильной работы компонента на удаленных компьютерах должна быть установлена одна из необходимых платформ.Remote computers must have one of the required platforms installed for the component to function properly.

Обратите внимание, что FileSystemWatcher может пропускать событие при превышении размера буфера.Note that a FileSystemWatcher may miss an event when the buffer size is exceeded. Чтобы избежать отсутствия событий, следуйте приведенным ниже рекомендациям.To avoid missing events, follow these guidelines:

• Увеличьте размер буфера, задав InternalBufferSize свойство.Increase the buffer size by setting the InternalBufferSize property.

• Избегайте просмотра файлов с длинными именами файлов, так как полное имя файла будет заполнять буфер.Avoid watching files with long file names, because a long file name contributes to filling up the buffer. Рекомендуется переименовать эти файлы, используя более короткие имена.Consider renaming these files using shorter names.

• Постарайтесь, чтобы код обработки событий был как можно более коротким.Keep your event handling code as short as possible.

Конструкторы

Свойства

Методы

События

Применяется к

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

• NotifyFilter
• NotifyFilters
• FileSystemEventArgs
• FileSystemEventHandler
• Filter
• IncludeSubdirectories
• InternalBufferOverflowException
• RenamedEventArgs
• RenamedEventHandler
• WaitForChangedResult
• WatcherChangeTypes
• Использование компонента FileSystemWatcher в форме Windows FormsUsing a FileSystemWatcher Component in a Windows Form