FileSystemWatcher Класс

Определение

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

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

type FileSystemWatcher = class
    inherit Component
    interface ISupportInitialize

Public Class FileSystemWatcher
Inherits Component
Implements ISupportInitialize

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

Object

MarshalByRefObject

Component

FileSystemWatcher

Атрибуты

IODescriptionAttribute IODescriptionAttribute

Реализации

ISupportInitialize

Примеры

В следующем примере создается объект 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.

#using <System.dll>

using namespace System;
using namespace System::IO;
using namespace System::Security::Permissions;

public ref class Watcher
{
private:
   // Define the event handlers.
   static void OnChanged( Object^ /*source*/, FileSystemEventArgs^ e )
   {
      // Specify what is done when a file is changed, created, or deleted.
      Console::WriteLine( "File: {0} {1}", e->FullPath, e->ChangeType );
   }

   static void OnRenamed( Object^ /*source*/, RenamedEventArgs^ e )
   {
      // Specify what is done when a file is renamed.
      Console::WriteLine( "File: {0} renamed to {1}", e->OldFullPath, e->FullPath );
   }

public:
   [PermissionSet(SecurityAction::Demand, Name="FullTrust")]
   int static run()
   {
      array<String^>^args = System::Environment::GetCommandLineArgs();

      // If a directory is not specified, exit program.
      if ( args->Length != 2 )
      {
         // Display the proper way to call the program.
         Console::WriteLine( "Usage: Watcher.exe (directory)" );
         return 0;
      }

      // Create a new FileSystemWatcher and set its properties.
      FileSystemWatcher^ watcher = gcnew FileSystemWatcher;
      watcher->Path = args[ 1 ];

      /* Watch for changes in LastAccess and LastWrite times, and 
          the renaming of files or directories. */
      watcher->NotifyFilter = static_cast<NotifyFilters>(NotifyFilters::LastAccess |
            NotifyFilters::LastWrite | NotifyFilters::FileName | NotifyFilters::DirectoryName);

      // Only watch text files.
      watcher->Filter = "*.txt";

      // Add event handlers.
      watcher->Changed += gcnew FileSystemEventHandler( Watcher::OnChanged );
      watcher->Created += gcnew FileSystemEventHandler( Watcher::OnChanged );
      watcher->Deleted += gcnew FileSystemEventHandler( Watcher::OnChanged );
      watcher->Renamed += gcnew RenamedEventHandler( Watcher::OnRenamed );

      // Begin watching.
      watcher->EnableRaisingEvents = true;

      // Wait for the user to quit the program.
      Console::WriteLine( "Press \'q\' to quit the sample." );
      while ( Console::Read() != 'q' );

      return 0;
   }
};

int main() {
   Watcher::run();
}

using System;
using System.IO;
using System.Security.Permissions;

public class Watcher
{
    public static void Main()
    {
        Run();
    }

    [PermissionSet(SecurityAction.Demand, Name = "FullTrust")]
    private static void Run()
    {
        string[] args = Environment.GetCommandLineArgs();

        // If a directory is not specified, exit program.
        if (args.Length != 2)
        {
            // Display the proper way to call the program.
            Console.WriteLine("Usage: Watcher.exe (directory)");
            return;
        }

        // Create a new FileSystemWatcher and set its properties.
        using (FileSystemWatcher watcher = new FileSystemWatcher())
        {
            watcher.Path = args[1];

            // Watch for changes in LastAccess and LastWrite times, and
            // the renaming of files or directories.
            watcher.NotifyFilter = NotifyFilters.LastAccess
                                 | NotifyFilters.LastWrite
                                 | NotifyFilters.FileName
                                 | NotifyFilters.DirectoryName;

            // Only watch text files.
            watcher.Filter = "*.txt";

            // Add event handlers.
            watcher.Changed += OnChanged;
            watcher.Created += OnChanged;
            watcher.Deleted += OnChanged;
            watcher.Renamed += OnRenamed;

            // Begin watching.
            watcher.EnableRaisingEvents = true;

            // Wait for the user to quit the program.
            Console.WriteLine("Press 'q' to quit the sample.");
            while (Console.Read() != 'q') ;
        }
    }

    // Define the event handlers.
    private static void OnChanged(object source, FileSystemEventArgs e) =>
        // Specify what is done when a file is changed, created, or deleted.
        Console.WriteLine($"File: {e.FullPath} {e.ChangeType}");

    private static void OnRenamed(object source, RenamedEventArgs e) =>
        // Specify what is done when a file is renamed.
        Console.WriteLine($"File: {e.OldFullPath} renamed to {e.FullPath}");
}

Imports System.IO
Imports System.Security.Permissions

Public Class Watcher

    Public Shared Sub Main()

        Run()

    End Sub

    <PermissionSet(SecurityAction.Demand, Name:="FullTrust")>
    Private Shared Sub Run()

        Dim args() As String = Environment.GetCommandLineArgs()

        ' If a directory is not specified, exit the program.
        If args.Length <> 2 Then
            ' Display the proper way to call the program.
            Console.WriteLine("Usage: Watcher.exe (directory)")
            Return
        End If

        ' Create a new FileSystemWatcher and set its properties.
        Using watcher As New FileSystemWatcher()
            watcher.Path = args(1)

            ' Watch for changes in LastAccess and LastWrite times, and
            ' the renaming of files or directories. 
            watcher.NotifyFilter = (NotifyFilters.LastAccess _
                                 Or NotifyFilters.LastWrite _
                                 Or NotifyFilters.FileName _
                                 Or NotifyFilters.DirectoryName)

            ' Only watch text files.
            watcher.Filter = "*.txt"

            ' Add event handlers.
            AddHandler watcher.Changed, AddressOf OnChanged
            AddHandler watcher.Created, AddressOf OnChanged
            AddHandler watcher.Deleted, AddressOf OnChanged
            AddHandler watcher.Renamed, AddressOf OnRenamed

            ' Begin watching.
            watcher.EnableRaisingEvents = True

            ' Wait for the user to quit the program.
            Console.WriteLine("Press 'q' to quit the sample.")
            While Chr(Console.Read()) <> "q"c
            End While
        End Using
    End Sub

    ' Define the event handlers.
    Private Shared Sub OnChanged(source As Object, e As FileSystemEventArgs)
        ' Specify what is done when a file is changed, created, or deleted.
        Console.WriteLine($"File: {e.FullPath} {e.ChangeType}")
    End Sub

    Private Shared Sub OnRenamed(source As Object, e As RenamedEventArgs)
        ' Specify what is done when a file is renamed.
        Console.WriteLine($"File: {e.OldFullPath} renamed to {e.FullPath}")
    End Sub

End Class

Комментарии

Используется 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. Например, чтобы отслеживать изменения в файле мидок. txt, задайте Filter для свойства значение "мидок. 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 и OnDeleted некоторые OnCreated события.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 объектов отслеживают один и тот же UNC-путь в Windows XP, предшествующий пакету обновления 1 (SP1) или Windows 2000 с пакетом обновления 2 (SP2), то событие будет вызвано только одним из этих объектов.If multiple FileSystemWatcher objects are watching the same UNC path in Windows XP prior to Service Pack 1, or Windows 2000 SP2 or earlier, then only one of the objects will raise an event. На компьютерах под управлением Windows XP с пакетом обновления 1 (SP1) и более поздних версий, FileSystemWatcher Windows 2000 SP3 или более поздней версии или Windows Server 2003 все объекты будут вызывать соответствующие события.On machines running Windows XP SP1 and newer, Windows 2000 SP3 or newer or Windows Server 2003, all FileSystemWatcher objects will raise the appropriate events.

Обратите внимание 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.

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

Свойства

Методы

События

Безопасность

SecurityPermission
для наследования от ProcessStartInfo класса.for deriving from the ProcessStartInfo class. Значение спроса: InheritanceDemand; Именованные наборы разрешений FullTrust:.Demand value: InheritanceDemand; Named Permission Sets: FullTrust.

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

Дополнительно

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