Click or drag to resize

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 Hierarchy
SystemObject
  ShellBoost.Core.UtilitiesLocalFileSystemWatcher

Namespace:  ShellBoost.Core.Utilities
Assembly:  ShellBoost.Core (in ShellBoost.Core.dll) Version: 1.8.3.0
Syntax
C#
public class LocalFileSystemWatcher : IDisposable

The LocalFileSystemWatcher type exposes the following members.

Constructors
  NameDescription
Public methodLocalFileSystemWatcher
Initializes a new instance of the LocalFileSystemWatcher class. Windows 10, version 1709 or higher is needed.
Top
Properties
  NameDescription
Public propertyBufferMaximumUsedSize
Gets the buffer maximum used size.
Public propertyBufferSize
Gets or sets the size (in bytes) of the events buffer.
Public propertyDirectoryPath
Gets the directory path.
Public propertyIncludeSubdirectories
Gets or sets a value indicating whether subdirectories within the specified path should be monitored.
Public propertyIsStarted
Gets a value that indicates whether this instance listens to events.
Public propertyLogger
Gets or sets an optional logger.
Public propertyNotifyFilter
Gets or sets the type of changes to watch for.
Public propertySetRelativePaths
Gets or sets a value indicating whether to set fully qualifed paths or a relative paths in LocalFileSystemWatcherEventArgs event instances.
Public propertySynthetizeCircularBufferSize
Gets or sets the size of the synthetize circular buffer. The minimum value is 10.
Public propertySynthetizeMaximumTime
Gets or sets the maximum time between two events that can be synthetized, in milliseconds. The minimum value is 20.
Public propertySynthetizeOptions
Gets the synthetize options.
Public propertySynthetizeTimerDuetime
Gets or sets the synthetize timer due time, in milliseconds. The minimum value is 20.
Public propertyVolumeGuid
Gets the directory path's volume GUID.
Top
Methods
  NameDescription
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Protected methodDispose(Boolean)
Releases unmanaged and - optionally - managed resources.
Protected methodFinalize
Finalizes an instance of the LocalFileSystemWatcher class.
(Overrides ObjectFinalize.)
Protected methodOnBufferTooSmall
Called when the BufferTooSmall event is raised.
Protected methodOnError
Called when the Error event is raised.
Protected methodOnEvent
Called when the Event event is raised.
Protected methodOnPreviewEvent
Called before the Event event is raised.
Protected methodRestart
Restarts the watcher.
Protected methodSkipSynthetization
Determines if synthetization must be skipped for an event.
Public methodStart
Starts listening to events.
Public methodStop
Stops listening to events.
Public methodStatic memberToGuidId
Converts an UInt64 file identifier to a Guid file identifier.
Public methodStatic memberToUInt64Id
Converts an Guid file identifier to a UInt64 file identifier.
Top
Events
  NameDescription
Public eventBufferTooSmall
Occurs when too many changes occur in the watched directory and changes have been lost.
Public eventError
Occurs when an error occurs in the watched directory. Changes may have been lost.
Public eventEvent
Occurs when a directory, or file in a directory, changes.
Top
Fields
  NameDescription
Public fieldStatic memberDefaultBufferSize
The default buffer size (65536).
Top
See Also