FileSyncProvider Constructor (String, FileSyncScopeFilter, FileSyncOptions)
Initializes a new instance of the FileSyncProvider class that is based on the specified root directory path, scope filter, and configuration options.
Assembly: Microsoft.Synchronization.Files (in Microsoft.Synchronization.Files.dll)
public:
FileSyncProvider(
String^ rootDirectoryPath,
FileSyncScopeFilter^ scopeFilter,
FileSyncOptions fileSyncOptions
)
Parameters
- rootDirectoryPath
- Type: System::String
The absolute path to the local file store for this provider. This is the folder that contains the files and subfolders to be synchronized.
- scopeFilter
- Type: Microsoft.Synchronization.Files::FileSyncScopeFilter
A static scope filter that specifies which files or directories in the local file store are included in the scope. Can be a nullptr.
- fileSyncOptions
- Type: Microsoft.Synchronization.Files::FileSyncOptions
Flags that determine the behavior of the provider during synchronization. The default value is None.
| Exception | Condition |
|---|---|
| ArgumentNullException | rootDirectoryPath is a nullptr. |
| ArgumentException | rootDirectoryPath is 0 length, rootDirectoryPath contains wildcards, or rootDirectoryPath does not exist. |
| ArgumentOutOfRangeException | fileSyncOptions is not in the FileSyncOptions enumeration. |
| ReplicaMetadataInUseException | Another provider instance was previously initialized with the same values for directory path and metadata file path, but has not yet been released. |
This form of the constructor can be used when the application does not use a replica ID to identify the replica. In this case, a replica ID is created and used by the object and stored in the metadata storage file.
This form of the constructor initializes the location of the metadata storage file and temporary files to be rootDirectoryPath. It initializes the path to save conflict loser files to a nullptr. It names the metadata storage file filesync.metadata.