LocalFileSystem Class |
An implementation of ISyncFileSystem for Windows 10 physical directories.
NTFS on Windows 10, version 1709 or higher is needed..
Inheritance HierarchySystemObject
ShellBoost.Core.SynchronizationLocalFileSystem
ShellBoost.Core.SynchronizationOnDemandLocalFileSystem
ShellBoost.Core.SynchronizationLocalFileSystem
ShellBoost.Core.SynchronizationOnDemandLocalFileSystem
Namespace: ShellBoost.Core.Synchronization
Assembly: ShellBoost.Core (in ShellBoost.Core.dll) Version: 1.8.3.0
SyntaxC#
public class LocalFileSystem : ISyncFileSystemRead, ISyncFileSystem, ISyncFileSystemWrite, ISyncFileSystemEvents, IDirectContentAccess, IDisposable
The LocalFileSystem type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | LocalFileSystem |
Initializes a new instance of the LocalFileSystem class.
|
Properties| Name | Description | |
|---|---|---|
 | DirectoryId |
Gets the directory identifier.
|
| DirectoryPath |
Gets the directory path.
|
| EndPointSynchronizer |
Gets or sets the endpoint synchronizer. The setter is reserved and should not be used.
|
| Options |
Gets the options.
|
| SelfEventsFilterMaximumDuration |
Gets the maximum duration of the self events filter.
|
| TempDirectoryPath |
Gets the temporary directory path.
|
| VolumeGuid |
Gets the volume GUID.
|
 | Watcher |
Gets the file system events watcher.
|
Methods| Name | Description | |
|---|---|---|
 | AddSelfEventFilter(LocalFileSystemEventFilter) |
Adds an event filter.
|
| AddSelfEventFilter(WatcherChangeTypes, String) |
Adds an event filter on a path using default filter maximum duration.
|
| ApplyContentChange |
Applies a content change.
|
| ClearTemporaryFiles |
Clears all temporary files possibly used by this instance for a content change.
|
| CopyTo |
Copies a file system entry to a state entry.
|
| CreateEntry |
Creates the entry.
|
| DeleteEntry |
Deletes an entry.
|
| DeleteFileSystemEntry |
Deletes a file system entry.
|
| DirectoryCreate |
Creates the specified directory.
|
| DirectoryDelete |
Deletes the specified directory and, if indicated, any subdirectories and files in the directory.
|
| Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
| Dispose(Boolean) |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
|
| EntryFromId |
Get a FileSystemEntry from a state identifier.
|
| EntryRename |
Renames an entry using its 128-bit identifier.
It can also be used to move a file if the newName parameter is set to a full file path.
Note this method cannot move from a volume to another.
|
| EnumerateEntries |
Enumerates the child entries of an entry.
|
| FileCreate |
Creates the specified file.
|
| FileDelete |
Deletes the specified file using its 128-bit identifier.
|
| FileOverwrite |
Overwrites a file.
|
| Finalize |
Frees all resources associated with this instance.
(Overrides ObjectFinalize.) |
| GetEntryContentAsync |
Gets the entry content.
|
 | GetFileAttributes |
Gets the file attributes from a sync entry.
|
| GetFullPath |
Gets the full path for a given file system entry.
Can be the entry FullName or the result of the GetFinalPath() method.
|
| GetId(FileSystemEntry) |
Gets the identifier from a file system entry.
|
| GetId(String, Guid) |
Gets the identifier.
|
| GetOrCreateEntry |
Gets or create the entry.
|
| GetRelativePathFromFullPath |
Gets a path relative to the root path, from a full path.
|
| GetSourceDownloadFileName |
Gets a file name for the downloaded file corresponding to a change. The file may not exist yet.
|
| GetSourceDownloadLocalPath |
Gets a local file path for the downloaded file corresponding to a change. The file may not exist yet.
|
| HasCapability |
Determines whether the specified capability is supported.
|
| IncludeEntry |
Determines if an entry should be included in enumeration.
|
| IsAlwaysSynchronized |
Determines whether this instance's entries are always synchronized.
|
| IsFiltered |
Determines whether the specified event must be filtered.
|
| IsFilteredByAttributes |
Determines whether the specified event must be filtered because it only represents an unused attribute change.
|
| IsSynchronized |
Determines whether the specified local relative path is synchronized.
This uses the state database and other endpoints information, not On-Demand file in-sync attributes.
|
| Log |
Logs the value at the specified trace level.
|
| NewSyncEntry |
Creates a new entry.
|
| NewWatcher |
Creates a new LocalFileSystemWatcher.
|
| NotifyShell |
Notifies the shell of an event.
|
| OnEvent |
Raises the SyncFileSystemEventArgs event.
|
| OnIncluding |
Raises the LocalFileSystemEntryIncludeEventArgs event.
|
| OnJobChanged |
Occurs when a job changed.
|
| OnPreviewWatcherEvent |
Handles a file system event before the OnWatcherEvent method.
|
| OnWatcherBufferTooSmall |
Handles the watcher's BufferTooSmall event.
|
| OnWatcherError |
Handles the watcher's Error event.
|
| OnWatcherEvent |
Handles a file system event.
|
| ParseId |
Parses an identifier as a string.
|
| RemoveSelfEventFilter |
Removes an event filter.
|
| SendEvent |
Sends and event as a file system implementer.
|
| SetBasicInformation |
Sets an entry basic information.
This implementation always returns true.
|
| SetEntryContentAsync |
Sets the entry content.
|
| SetFileAttributes |
Sets the file attributes to a sync entry.
|
| SetSize |
Sets an entry size.
This implementation always returns true.
|
| StartEventMonitoring |
Starts the events monitoring.
|
| StopEventMonitoring |
Stops the events monitoring.
|
| ToAttributes(FileAttributes) |
Converts to attributes.
|
| ToAttributes(SyncEntryAttributes) |
Converts to attributes.
|
| ToEntry |
Converts an event to an entry.
|
| ToString |
Returns a String that represents this instance.
(Overrides ObjectToString.) |
| UpdateEntry |
Updates an entry.
|
| UpdateFileSystemEntry |
Called after an entry has been updated.
This implementation does nothing
|
| WithSelfEventFilter(LocalFileSystemEventFilter, Action) |
Runs an action with an event filter applied.
|
| WithSelfEventFilterT(LocalFileSystemEventFilter, FuncT) |
Runs a function with an event filter applied.
|
Events| Name | Description | |
|---|---|---|
 | Event |
Occurs when a file system event occurs.
|
| Including |
Occurs when a FileSystemEntry is being included.
|
See Also