FileSyncOptions Enumeration
Provides options to configure the behavior of the file synchronization provider.
Namespace: Microsoft.Synchronization.Files
Assembly: Microsoft.Synchronization.Files (in microsoft.synchronization.files.dll)
Syntax
'Declaration
<FlagsAttribute> _
Public Enumeration FileSyncOptions
'Usage
Dim instance As FileSyncOptions
[FlagsAttribute]
public enum FileSyncOptions
[FlagsAttribute]
public enum class FileSyncOptions
/** @attribute FlagsAttribute() */
public enum FileSyncOptions
FlagsAttribute
public enum FileSyncOptions
Members
| Member name | Description | |
|---|---|---|
| CompareFileStreams | If this value is set, the provider will compute a hash value for each file that is based on the contents of the whole file stream and use this value to compare files during change detection. This option is expensive and will slow synchronization, but provides more robust change detection. If this value is not set, an algorithm that compares modification times, file sizes, file names, and file attributes will be used to determine whether a file has changed. | |
| ExplicitDetectChanges | If this value is set, the provider will perform change detection only when DetectChanges is called. If this value is not set, change detection is implicitly done on the first call to the provider's GetChangeBatch or ProcessChangeBatch method. | |
| None | If this value is set, the provider will use its default configuration options. Setting any of the other flags overrides this setting. This is the default setting. | |
| RecycleConflictLoserFiles | If this value is set, the provider will move files that are conflict losers to the recycle bin. If this value is not set, the provider will move the files to a specified location. Or, if no location is specified, the files will be permanently deleted. | |
| RecycleDeletedFiles | If this value is set, the provider will move files deleted during change application to the recycle bin. If this value is not set, files will be permanently deleted. | |
| RecyclePreviousFileOnUpdates | If this value is set, the provider will move files overwritten during change application to the recycle bin. If this value is not set, files will be overwritten in place and any data in the old file will be lost. |
Remarks
This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.
A value that contains a combination of these options can be passed to FileSyncProvider to configure the way the file synchronization provider will handle different parts of the synchronization process.