OnDemandLocalFileSystem Class |
An on-demand 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 OnDemandLocalFileSystem : LocalFileSystem, IProgressSink, ISyncFileSystemSynchronizationEventsSink
The OnDemandLocalFileSystem type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | OnDemandLocalFileSystem |
Initializes a new instance of the OnDemandLocalFileSystem class.
|
Properties| Name | Description | |
|---|---|---|
 | DirectoryId |
Gets the directory identifier.
(Inherited from LocalFileSystem.) |
| DirectoryPath |
Gets the directory path.
(Inherited from LocalFileSystem.) |
| EnableOnDemandContent |
Gets a value indicating whether on-demand content is enabled.
|
| EndPointSynchronizer |
Gets or sets the endpoint synchronizer. The setter is reserved and should not be used.
(Overrides LocalFileSystemEndPointSynchronizer.) |
 | FilterDriverVersion |
Gets the filter driver version.
|
| IsSupported |
Gets a value indicating whether Files On-Demand technology is supported on the current platform.
Windows 10, version 1709 or higher is needed.
|
| Options |
Gets the options.
|
| PlaformInfo |
Gets plaform information version.
|
| SelfEventsFilterMaximumDuration |
Gets the maximum duration of the self events filter.
(Inherited from LocalFileSystem.) |
| TempDirectoryPath |
Gets the temporary directory path.
(Inherited from LocalFileSystem.) |
| VolumeGuid |
Gets the volume GUID.
(Inherited from LocalFileSystem.) |
 | Watcher |
Gets the file system events watcher.
(Inherited from LocalFileSystem.) |
Methods| Name | Description | |
|---|---|---|
 | AcknowledgeData |
Acknowledges the data when requested by the ValidateData method.
|
| AddSelfEventFilter(LocalFileSystemEventFilter) |
Adds an event filter.
(Inherited from LocalFileSystem.) |
| AddSelfEventFilter(WatcherChangeTypes, String) |
Adds an event filter on a path using default filter maximum duration.
(Inherited from LocalFileSystem.) |
| AddToWaitingForSynchronization |
Adds a file system entry to the list of entries waiting to be synchronized.
|
| ApplyContentChange |
Applies a content change.
(Inherited from LocalFileSystem.) |
| CancelHydrateData |
Cancels data hydration process.
|
| CheckSupported |
Checks the Files On-Demand technology is supported.
|
| ClearTemporaryFiles |
Clears all temporary files possibly used by this instance for a content change.
(Inherited from LocalFileSystem.) |
| ConvertMarkInSync |
Should an On-Demand file or folder be marked in-sync when converted.
|
| ConvertToOnDemandEntry |
Converts a regular file into an On-Demand entry.
|
| CopyTo |
Copies a file system entry to a state entry.
(Inherited from LocalFileSystem.) |
| CreateEntry |
Creates the entry.
(Overrides LocalFileSystemCreateEntry(SyncContext, String, StateSyncEntry).) |
| CreateMarkInSync |
Should an On-Demand file or folder be marked in-sync when created.
|
| CreateOnDemandEntry |
Converts a regular file or folder into an On-Demand entry.
|
| DehydrateOnDemandEntry |
Dehydrates an On-Demand file by removing ('Free up space') its content on-disk.
|
| DeleteEntry |
Deletes an entry.
(Inherited from LocalFileSystem.) |
| DeleteFileSystemEntry |
Deletes a file system entry.
(Inherited from LocalFileSystem.) |
| DirectoryCreate |
Creates the specified directory.
(Inherited from LocalFileSystem.) |
| DirectoryDelete |
Deletes the specified directory and, if indicated, any subdirectories and files in the directory.
(Inherited from LocalFileSystem.) |
| Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from LocalFileSystem.) |
| Dispose(Boolean) |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Overrides LocalFileSystemDispose(Boolean).) |
| EnsureRegistered |
Ensures an On-Demand synchronizer is registered.
|
| EnsureRegisteredForShell |
Ensures the registry is configured properly to support Explorer features of On-Demand file synchronization.
|
| EntryFromId |
Get a FileSystemEntry from a state identifier.
(Inherited from LocalFileSystem.) |
| 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.
(Overrides LocalFileSystemEntryRename(String, String, Boolean).) |
| EnumerateEntries |
Enumerates the child entries of an entry.
(Inherited from LocalFileSystem.) |
| ExcludeOnDemandEntry |
The On-Demand file or folder will be excluded for synchronization with the system.
|
| FileCreate |
Creates the specified file.
(Inherited from LocalFileSystem.) |
| FileDelete |
Deletes the specified file using its 128-bit identifier.
(Inherited from LocalFileSystem.) |
| FileOverwrite |
Overwrites a file.
(Overrides LocalFileSystemFileOverwrite(String, String, Boolean, Boolean).) |
| Finalize |
Frees all resources associated with this instance.
(Inherited from LocalFileSystem.) |
| GetEntryContentAsync |
Gets the entry content.
(Inherited from LocalFileSystem.) |
| GetFullPath |
Gets the full path for a given file system entry.
Can be the entry FullName or the result of the GetFinalPath() method.
(Inherited from LocalFileSystem.) |
| GetHydrationRequiredCount |
Computes the hydration required count of bytes.
|
| GetId(FileSystemEntry) |
Gets the identifier from a file system entry.
(Inherited from LocalFileSystem.) |
| GetId(String, Guid) |
Gets the identifier.
(Inherited from LocalFileSystem.) |
| GetIdentity |
Gets the identity of a local file.
|
| GetOrCreateEntry |
Gets or create the entry.
(Inherited from LocalFileSystem.) |
| GetRelativePathFromFullPath |
Gets a path relative to the root path, from a full path.
(Inherited from LocalFileSystem.) |
| GetSourceDownloadFileName |
Gets a file name for the downloaded file corresponding to a change. The file may not exist yet.
(Inherited from LocalFileSystem.) |
| GetSourceDownloadLocalPath |
Gets a local file path for the downloaded file corresponding to a change. The file may not exist yet.
(Inherited from LocalFileSystem.) |
| HandleHydrationError |
Handles hydration error.
|
| HandleSharingViolation |
Handles a possible sharing violation error in a specific way.
|
| HasCapability |
Determines whether the specified capability is supported.
(Overrides LocalFileSystemHasCapability(SyncFileSystemCapability).) |
| HydrateDataAsync |
Hydrates the data of an On-Demand file.
|
| HydrateOnDemandEntry |
Hydrates an On-Demand file by ensuring that content is present on-disk.
|
| IncludeEntry |
Determines if an entry should be included in enumeration.
(Inherited from LocalFileSystem.) |
| InheritPinOnDemandEntry |
The On-Demand file or folder pin state is evaluated based on its parent's pin state.
|
| IsAlwaysSynchronized |
Determines whether this instance's entries are always synchronized.
(Overrides LocalFileSystemIsAlwaysSynchronized(IReadOnlyListEndPointSynchronizer).) |
| IsFiltered |
Determines whether the specified event must be filtered.
(Inherited from LocalFileSystem.) |
| IsFilteredByAttributes |
Determines whether the specified event must be filtered because it only represents an unused attribute change.
(Inherited from LocalFileSystem.) |
| IsHydrating |
Determines whether the specified local relative path is currently hydrating.
|
| IsOnDemandEntry |
Determines if a file is an On-Demand entry.
|
| IsOnDemandEntryExcluded |
Determines if an On-Demand file or folder is excluded.
|
| IsOnDemandEntryInSync |
Determines if an On-Demand file or folder is in-sync.
|
| IsOnDemandEntryNotInSync |
Determines if an On-Demand file or folder is not in-sync.
|
| IsOnDemandEntryPinned |
Determines if an On-Demand file or folder is pinned.
|
| IsOnDemandEntryUnpinned |
Determines if an On-Demand file or folder is unpinned.
|
| IsOnDemandEntryUnspecified |
Determines if an On-Demand file or folder pin state is unspecified.
|
| 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.
(Inherited from LocalFileSystem.) |
| Log |
Logs the value at the specified trace level.
(Overrides LocalFileSystemLog(TraceLevel, Object, String).) |
| NewSyncEntry |
Creates a new entry.
(Inherited from LocalFileSystem.) |
| NewWatcher |
Creates a new LocalFileSystemWatcher.
(Inherited from LocalFileSystem.) |
| NotifyDehydrateOnDemandEntry |
Called by the file system when an On-Demand file is being dehydrated.
|
| NotifyDehydrateOnDemandEntryCompletion |
Called by the file system when an On-Demand file has been dehydrated.
|
| NotifyDeleteOnDemandEntry |
Called by the file system when an On-Demand file is being deleted.
|
| NotifyDeleteOnDemandEntryCompletion |
Called by the file system when a delete has completed.
|
| NotifyFileCloseCompletion |
Called by the file system when a file close has completed.
|
| NotifyFileOpenCompletion |
Called by the file system when a file open has completed.
|
| NotifyRenameOnDemandEntry |
Called by the file system when an On-Demand file is being renamed.
|
| NotifyRenameOnDemandEntryCompletion |
Called by the file system when a rename has completed.
|
| NotifyShell |
Notifies the shell of an event.
(Inherited from LocalFileSystem.) |
| OnEvent |
Raises the SyncFileSystemEventArgs event.
(Inherited from LocalFileSystem.) |
| OnIncluding |
Raises the LocalFileSystemEntryIncludeEventArgs event.
(Inherited from LocalFileSystem.) |
| OnJobChanged |
Occurs when a job changed.
(Overrides LocalFileSystemOnJobChanged(SyncJobChangedEventArgs).) |
| OnPreviewWatcherEvent |
Handles a file system event before the OnWatcherEvent method.
(Inherited from LocalFileSystem.) |
| OnSavedChange |
Called when a change has been written.
|
| OnSavingChange |
Called when a change has been written.
|
| OnWatcherBufferTooSmall |
Handles the watcher's BufferTooSmall event.
(Inherited from LocalFileSystem.) |
| OnWatcherError |
Handles the watcher's Error event.
(Overrides LocalFileSystemOnWatcherError(ErrorEventArgs).) |
| OnWatcherEvent |
Handles a file system event.
(Overrides LocalFileSystemOnWatcherEvent(LocalFileSystemWatcherEventArgs).) |
| ParseId |
Parses an identifier as a string.
(Inherited from LocalFileSystem.) |
| PinOnDemandEntry |
Asks the system to pin (check 'Always keep on this device') the On-Demand file or folder content.
|
| RemoveAsOnDemandEntry |
Disconnect the file from the synchronization root.
|
| RemoveSelfEventFilter |
Removes an event filter.
(Inherited from LocalFileSystem.) |
| ReportErrorToShell |
Report error to the Shell.
|
| ReportProgress |
Report progress to the file system.
|
| ReportProgressToShell(OnDemandCallbackContext, Int64, Int64) |
Report progress to the Shell.
|
| ReportProgressToShell(OnDemandLocalFileSystem, String, Int64, Int64, Boolean) |
Report progress to the Shell.
|
| ReportSyncStatus |
Reports this instance synchronize status.
|
| SendEvent |
Sends and event as a file system implementer.
(Inherited from LocalFileSystem.) |
| SetBasicInformation |
Sets an entry basic information.
(Overrides LocalFileSystemSetBasicInformation(SyncContext, StateSyncEntry).) |
| SetEntryContentAsync |
Sets the entry content.
(Inherited from LocalFileSystem.) |
| SetInSyncOnDemandEntry |
The On-Demand file will be set in sync for synchronization with the system.
|
| SetNotInSyncOnDemandEntry |
The On-Demand file will be set not in sync for synchronization with the system.
|
| SetSize |
Sets an entry size.
This implementation always returns true.
(Inherited from LocalFileSystem.) |
| StartEventMonitoring |
Starts the events monitoring.
(Inherited from LocalFileSystem.) |
| StartFetchDataAction |
Starts the action prepared by this class for fetching data.
This can be used to vary how the action is started (new thread, thread pool, etc.)
|
| StopEventMonitoring |
Stops the events monitoring.
(Inherited from LocalFileSystem.) |
| ToAttributes(FileAttributes) |
Converts to attributes.
(Inherited from LocalFileSystem.) |
| ToAttributes(SyncEntryAttributes) |
Converts to attributes.
(Inherited from LocalFileSystem.) |
| ToEntry |
Converts an event to an entry.
(Inherited from LocalFileSystem.) |
| ToString |
Returns a String that represents this instance.
(Inherited from LocalFileSystem.) |
| UnpinOnDemandEntry |
Asks the system to unpin (uncheck 'Always keep on this device') the On-Demand file or folder content.
|
| Unregister |
Unregisters an On-Demand synchronizer.
|
| UnspecifyOnDemandEntry |
The On-Demand file or folder pin state is not specififed.
|
| UpdateAllEntriesStates |
Updates all entries on-demand states.
This must be called only when the MultiPointSynchronizer is started.
|
| UpdateEntry(String, Boolean) |
Updates an on-demand entry.
|
| UpdateEntry(SyncContext, StateSyncEntry, SyncUpdateEntryOptions) |
Updates an entry.
(Inherited from LocalFileSystem.) |
| UpdateEntryStates |
Updates an entry on-demand entry states.
|
| UpdateFileSystemEntry |
Called after a sync state entry has been updated.
(Overrides LocalFileSystemUpdateFileSystemEntry(SyncContext, StateSyncEntry, FileSystemEntry, SyncUpdateEntryOptions).) |
| UpdateMarkInSync |
Should an On-Demand file or folder be marked in-sync when updated.
|
| UpdateOnDemandEntry |
Updates an on demand file or folder entry from an entry information.
|
| UpdateStatus |
Updates this engine status.
|
| ValidateData |
Validates the data of an On-Demand file.
|
| WithSelfEventFilter(LocalFileSystemEventFilter, Action) |
Runs an action with an event filter applied.
(Inherited from LocalFileSystem.) |
| WithSelfEventFilterT(LocalFileSystemEventFilter, FuncT) |
Runs a function with an event filter applied.
(Inherited from LocalFileSystem.) |
Events| Name | Description | |
|---|---|---|
 | Event |
Occurs when a file system event occurs.
(Inherited from LocalFileSystem.) |
| Including |
Occurs when a FileSystemEntry is being included.
(Inherited from LocalFileSystem.) |
See Also