System.IO.FileSystemWatcher 类
方法描述
侦听文件系统更改通知，并在目录或目录中的文件发生更改时引发事件。
语法定义(C# System.IO.FileSystemWatcher 类 的用法)
[IODescriptionAttribute("FileSystemWatcherDesc")]
[PermissionSetAttribute(SecurityAction.LinkDemand, Name = "FullTrust")]
[PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")]
public class FileSystemWatcher : Component,
ISupportInitialize
构造函数
| 构造函数名称 | 构造函数描述 |
|---|---|
| FileSystemWatcher() | 初始化 FileSystemWatcher 类的新实例。 |
| FileSystemWatcher(String) | 给定要监视的指定目录，初始化 FileSystemWatcher 类的新实例。 |
| FileSystemWatcher(String, String) | 给定要监视的指定目录和文件类型，初始化 FileSystemWatcher 类的新实例。 |
成员/方法
| 方法名称 | 方法描述 |
|---|---|
| BeginInit | 开始初始化在窗体上使用或由另一个组件使用的 FileSystemWatcher。 初始化发生在运行时。 |
| CreateObjRef | 创建一个对象，该对象包含生成用于与远程对象进行通信的代理所需的全部相关信息。 （继承自 MarshalByRefObject。） |
| Dispose() | 释放由 Component 使用的所有资源。 （继承自 Component。） |
| Dispose(Boolean) | 释放由 FileSystemWatcher 占用的非托管资源，还可以另外再释放托管资源。 （重写 Component.Dispose(Boolean)。） |
| EndInit | 结束在窗体上使用或由另一个组件使用的 FileSystemWatcher 的初始化。 初始化发生在运行时。 |
| Equals(Object) | 确定指定的 Object 是否等于当前的 Object。 （继承自 Object。） |
| Finalize | 在通过垃圾回收将 Component 回收之前，释放非托管资源并执行其他清理操作。 （继承自 Component。） |
| GetHashCode | 用作特定类型的哈希函数。 （继承自 Object。） |
| GetLifetimeService | 检索控制此实例的生存期策略的当前生存期服务对象。 （继承自 MarshalByRefObject。） |
| GetService | 返回一个对象，该对象表示由 Component 或它的 Container 提供的服务。 （继承自 Component。） |
| GetType | 获取当前实例的 Type。 （继承自 Object。） |
| InitializeLifetimeService | 获取控制此实例的生存期策略的生存期服务对象。 （继承自 MarshalByRefObject。） |
| MemberwiseClone() | 创建当前 Object 的浅表副本。 （继承自 Object。） |
| MemberwiseClone(Boolean) | 创建当前 MarshalByRefObject 对象的浅表副本。 （继承自 MarshalByRefObject。） |
| OnChanged | 引发 Changed 事件。 |
| OnCreated | 引发 Created 事件。 |
| OnDeleted | 引发 Deleted 事件。 |
| OnError | 引发 Error 事件。 |
| OnRenamed | 引发 Renamed 事件。 |
| ToString | 返回包含 Component 的名称的 String（如果有）。 不应重写此方法。 （继承自 Component。） |
| WaitForChanged(WatcherChangeTypes) | 一种给定了要监视的更改类型的同步方法，该方法返回包含有关所发生更改的特定信息的结构。 |
| WaitForChanged(WatcherChangeTypes, Int32) | 一种给定了要监视的更改类型和超时前等待的时间（以毫秒表示）的同步方法，该方法返回包含有关所发生更改的特定信息的结构。 |
提示和注释
使用 FileSystemWatcher 监视指定目录中的更改。 可监视指定目录中的文件或子目录的更改。 可以创建一个组件来监视本地计算机、网络驱动器或远程计算机上的文件。
若要监视所有文件中的更改，请将 Filter 属性设置为空字符串 ("") 或使用通配符（“*.*”）。 若要监视特定的文件，请将 Filter 属性设置为该文件名。 例如，若要监视文件 MyDoc.txt 中的更改，请将 Filter 属性设置为“MyDoc.txt”。 也可以监视特定类型文件中的更改。 例如，若要监视文本文件中的更改，请将 Filter 属性设置为“*.txt”。
可监视目录或文件中的若干种更改。 例如，可监视文件或目录的 Attributes、LastWrite 日期和时间或 Size 方面的更改。 通过将 NotifyFilter 属性设置为 NotifyFilters 值之一来达到此目的。 有关可监视的更改类型的更多信息，请参见 NotifyFilters。
可监视文件或目录的重命名、删除或创建。 例如，若要监视文本文件的重命名，请将 Filter 属性设置为“*.txt”，并使用为其参数指定的 Renamed 来调用 WaitForChanged 方法。
Windows 操作系统在 FileSystemWatcher 创建的缓冲区中通知组件文件发生更改。 如果短时间内有很多更改，则缓冲区可能会溢出。 这将导致组件失去对目录更改的跟踪，并且它将只提供一般性通知。 使用 InternalBufferSize 属性来增加缓冲区大小的开销较大，因为它来自无法换出到磁盘的非页面内存，所以应确保缓冲区大小适中（尽量小，但也要有足够大小以便不会丢失任何文件更改事件）。 若要避免缓冲区溢出，请使用 NotifyFilter 和 IncludeSubdirectories 属性，以便可以筛选掉不想要的更改通知。
有关 FileSystemWatcher 的实例的初始属性值列表，请参见 FileSystemWatcher 构造函数。
使用 FileSystemWatcher 类时，请注意以下事项。
不忽略隐藏文件。
在某些系统中，FileSystemWatcher 使用 8.3 短文件名格式报告文件更改。 例如，对“LongFileName.LongExtension”的更改可能报告为“LongFil~.Lon”。
此类在应用于所有成员的类级别上包含一个链接要求和一个继承要求。 如果直接调用方或派生类不具有完全信任权限，则会引发 SecurityException。 有关安全要求的详细信息，请参见 链接需求。
您可以为 InternalBufferSize 属性（用于监视网络上的目录）设置的最大大小为 64 KB。
注意
Windows 98 上不支持运行 FileSystemWatcher。
复制和移动文件夹
操作系统和 FileSystemWatcher 对象将剪切和粘贴操作或移动操作解释为对文件夹及其内容的重命名操作。 如果将包含文件的文件夹剪切并粘贴到受监视的文件夹中，则 FileSystemWatcher 对象仅将文件夹报告为新建，但不能将其内容报告为新建，因为实际上只是对它们进行了重命名。
若要接收已将文件夹内容移动或复制到受监视的文件夹中的通知，请根据下表中的建议提供 OnChanged 和 OnRenamed 事件处理程序方法。
事件处理程序
已处理的事件
执行
OnChanged
Changed , Created, Deleted
报告文件特性的更改、创建的文件和删除的文件。
OnRenamed
Renamed
列出重命名的文件和文件夹的新旧路径，需要时可以递归扩展。
事件和缓冲区大小
请注意，有几个因素可能影响引发哪些文件系统更改事件，如下所述：
公共文件系统操作可能会引发多个事件。 例如，将文件从一个目录移到另一个目录时，可能会引发若干 OnChanged 以及一些 OnCreated 和 OnDeleted 事件。 移动文件是一个包含多个简单操作的复杂操作，因此会引发多个事件。 同样，有些应用程序（例如，防病毒软件）可能会导致可由 FileSystemWatcher 检测到的其他文件系统事件。
只要磁盘没有切换或移除，FileSystemWatcher 就可监视它们。 因为 CD 和 DVD 的时间戳和属性不能更改，所以 FileSystemWatcher 不为 CD 和 DVD 引发事件。 要使该组件正常运行，远程计算机必须具有所需的这些平台之一。
在 Windows XP（Service Pack 1 之前版本）或者 Windows 2000 SP2 或更低版本中，如果多个 FileSystemWatcher 对象正在监视同一个 UNC 路径，则只有其中一个对象会引发事件。 在运行 Windows XP SP1 及之后版本、Windows 2000 SP3 或之后版本或者 Windows Server 2003 的计算机上，所有 FileSystemWatcher 对象都将引发相应的事件。
请注意，当缓冲区大小溢出时，FileSystemWatcher 可能会错过事件。 若要防止丢失事件，请遵从这些准则：
通过设置 InternalBufferSize 属性来增加缓冲区大小。
避免看长文件名的文件，因为长文件名有助于填满缓冲区。 考虑使用较短的名称重命名这些文件。
尽可能使事件处理代码短小。
System.IO.FileSystemWatcher 类例子
在此示例中使用 System.Diagnostics 和 System.IO 命名空间。
using System;
using System.IO;
using System.Security.Permissions;
public class Watcher
{
public static void Main()
{
Run();
}
[PermissionSet(SecurityAction.Demand, Name="FullTrust")]
public static void Run()
{
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;
}
// Create a new FileSystemWatcher and set its properties.
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 += new FileSystemEventHandler(OnChanged);
watcher.Created += new FileSystemEventHandler(OnChanged);
watcher.Deleted += new FileSystemEventHandler(OnChanged);
watcher.Renamed += new RenamedEventHandler(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: {0} renamed to {1}", e.OldFullPath, e.FullPath);
}
}
线程安全
此类型的任何公共 static（在 Visual Basic 中为 Shared） 成员都是线程安全的。但不保证所有实例成员都是线程安全的。
版本信息
.NET Framework 受以下版本支持：4、3.5、3.0、2.0、1.1、1.0 .NET Framework Client Profile 受以下版本支持：4、3.5 SP1
适用平台
Windows 7, Windows Vista SP1 或更高版本, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008（不支持服务器核心）, Windows Server 2008 R2（支持 SP1 或更高版本的服务器核心）, Windows Server 2003 SP2 .NET Framework 并不是对每个平台的所有版本都提供支持。有关支持的版本的列表，请参见.NET Framework 系统要求。