FileSystemWatcher.IncludeSubdirectories Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets a value indicating whether subdirectories within the specified path should be monitored.

Namespace:   System.IO
Assembly:  System (in System.dll)

[IODescriptionAttribute("FSW_IncludeSubdirectories")]
public bool IncludeSubdirectories { get; set; }

Property Value

Type: System.Boolean

true if you want to monitor subdirectories; otherwise, false. The default is false.

Set IncludeSubdirectories to true when you want to watch for change notifications for files and directories contained within the directory specified through the Path property, and its subdirectories. Setting the IncludeSubdirectories property to false helps reduce the number of notifications sent to the internal buffer. For more information on filtering out unwanted notifications, see the NotifyFilter and InternalBufferSize properties.

When true, IncludeSubdirectories is recursive through the entire sub tree, not just the immediate child directories. The relative path to a file or directory within the sub tree returns in the Name property of FileSystemEventArgs and the OldName property of RenamedEventArgs, depending on changes you are watching for. You can get the fully qualified path from the FullPath property of FileSystemEventArgs and the OldFullPath property of RenamedEventArgs, depending on the changes you are watching for.

If a directory is created in the sub tree of the directory you are watching, and IncludeSubdirectories is true, that directory will automatically be watched.

.NET Framework
Available since 1.1
Return to top
Show: