FileSystemWatcher.IncludeSubdirectories Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets a value indicating whether subdirectories within the specified path should be monitored.
public:
property bool IncludeSubdirectories { bool get(); void set(bool value); };public bool IncludeSubdirectories { get; set; }[System.IO.IODescription("FSW_IncludeSubdirectories")]
public bool IncludeSubdirectories { get; set; }member this.IncludeSubdirectories : bool with get, set[<System.IO.IODescription("FSW_IncludeSubdirectories")>]
member this.IncludeSubdirectories : bool with get, setPublic Property IncludeSubdirectories As BooleanProperty Value
true if you want to monitor subdirectories; otherwise, false. The default is false.
- Attributes
Remarks
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 subtree, not just the immediate child directories. The relative path to a file or directory within the subtree 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 subtree of the directory you are watching, and IncludeSubdirectories is true, that directory will automatically be watched.
