EngineWindowsStartAsync Method |
IT Hit User File System
Starts listening and processing file system calls from operating system.
Namespace:
ITHit.FileSystem.Windows
Assembly:
ITHit.FileSystem.Windows (in ITHit.FileSystem.Windows.dll) Version: 9.0.29481.0-Beta
Syntaxpublic override Task StartAsync(
bool processChanges = true,
CancellationToken cancellationToken = null
)
Public Overrides Function StartAsync (
Optional processChanges As Boolean = true,
Optional cancellationToken As CancellationToken = Nothing
) As Task
public:
virtual Task^ StartAsync(
bool processChanges = true,
CancellationToken cancellationToken = nullptr
) override
abstract StartAsync :
?processChanges : bool *
?cancellationToken : CancellationToken
(* Defaults:
let _processChanges = defaultArg processChanges true
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task
override StartAsync :
?processChanges : bool *
?cancellationToken : CancellationToken
(* Defaults:
let _processChanges = defaultArg processChanges true
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task
Parameters
- processChanges (Optional)
- Type: SystemBoolean
If this parameter is true, syncs changes made in the
user file system when the Engine was not running to the remote storage.
- cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The token to monitor for cancellation requests.
Return Value
Type:
TaskA task object that can be awaited.
Remarks
If processChanges parameter is true and any files or folders were created, updated,
deleted, moved, pinned or unpinned in the user file system, the Engine will call IFile
and IFolder interface methods to sync changes from the user
file system to the remote storage when starting.
Otherwise changes will not be processed. On Windows platform, to process changes, you will call the
[!:Engine.SyncService.Outgoing.ProcessAsync] method when needed.
See Also