LocalFileSystemWatcher Class |
Listens to the file system change notifications and raises events when a directory, or file in a directory, changes.
Windows 10, version 1709 or higher is needed..
Inheritance HierarchyNamespace: callback.ShellBoost.Core.Utilities
Assembly: callback.CBFSShell (in callback.CBFSShell.dll) Version: 22.0.0.0
SyntaxC#
public class LocalFileSystemWatcher : IDisposable
The LocalFileSystemWatcher type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | LocalFileSystemWatcher |
Initializes a new instance of the LocalFileSystemWatcher class.
Windows 10, version 1709 or higher is needed.
|
Properties| Name | Description | |
|---|---|---|
 | BufferMaximumUsedSize |
Gets the buffer maximum used size.
|
| BufferSize |
Gets or sets the size (in bytes) of the events buffer.
|
| DirectoryPath |
Gets the directory path.
|
| IncludeSubdirectories |
Gets or sets a value indicating whether subdirectories within the specified path should be monitored.
|
| IsStarted |
Gets a value that indicates whether this instance listens to events.
|
| Logger |
Gets or sets an optional logger.
|
| NotifyFilter |
Gets or sets the type of changes to watch for.
|
| SetRelativePaths |
Gets or sets a value indicating whether to set fully qualifed paths or a relative paths in LocalFileSystemWatcherEventArgs event instances.
|
| SynthetizeCircularBufferSize |
Gets or sets the size of the synthetize circular buffer.
The minimum value is 10.
|
| SynthetizeMaximumTime |
Gets or sets the maximum time between two events that can be synthetized, in milliseconds.
The minimum value is 20.
|
| SynthetizeOptions |
Gets the synthetize options.
|
| SynthetizeTimerDuetime |
Gets or sets the synthetize timer due time, in milliseconds.
The minimum value is 20.
|
| VolumeGuid |
Gets the directory path's volume GUID.
|
Methods| Name | Description | |
|---|---|---|
| Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
 | Dispose(Boolean) |
Releases unmanaged and - optionally - managed resources.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize |
Finalizes an instance of the LocalFileSystemWatcher class.
(Overrides ObjectFinalize.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnBufferTooSmall |
Called when the BufferTooSmall event is raised.
|
| OnError |
Called when the Error event is raised.
|
| OnEvent |
Called when the Event event is raised.
|
| OnPreviewEvent |
Called before the Event event is raised.
|
| Restart |
Restarts the watcher.
|
| SkipSynthetization |
Determines if synthetization must be skipped for an event.
|
| Start |
Starts listening to events.
|
| Stop |
Stops listening to events.
|
 | ToGuidId |
Converts an UInt64 file identifier to a Guid file identifier.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| ToUInt64Id |
Converts an Guid file identifier to a UInt64 file identifier.
|
Events| Name | Description | |
|---|---|---|
 | BufferTooSmall |
Occurs when too many changes occur in the watched directory and changes have been lost.
|
| Error |
Occurs when an error occurs in the watched directory. Changes may have been lost.
|
| Event |
Occurs when a directory, or file in a directory, changes.
|
Fields| Name | Description | |
|---|---|---|
 | DefaultBufferSize |
The default buffer size (65536).
|
See Also