FileSyncProvider Constructor (Guid, String, FileSyncScopeFilter, FileSyncOptions)
Initializes a new instance of the FileSyncProvider class that is based on the specified replica ID, root directory path, scope filter, and configuration options.
Namespace: Microsoft.Synchronization.Files
Assembly: Microsoft.Synchronization.Files (in Microsoft.Synchronization.Files.dll)
Syntax
'Declaration
Public Sub New ( _
replicaId As Guid, _
rootDirectoryPath As String, _
scopeFilter As FileSyncScopeFilter, _
fileSyncOptions As FileSyncOptions _
)
'Usage
Dim replicaId As Guid
Dim rootDirectoryPath As String
Dim scopeFilter As FileSyncScopeFilter
Dim fileSyncOptions As FileSyncOptions
Dim instance As New FileSyncProvider(replicaId, _
rootDirectoryPath, scopeFilter, _
fileSyncOptions)
public FileSyncProvider(
Guid replicaId,
string rootDirectoryPath,
FileSyncScopeFilter scopeFilter,
FileSyncOptions fileSyncOptions
)
public:
FileSyncProvider(
Guid replicaId,
String^ rootDirectoryPath,
FileSyncScopeFilter^ scopeFilter,
FileSyncOptions fileSyncOptions
)
new :
replicaId:Guid *
rootDirectoryPath:string *
scopeFilter:FileSyncScopeFilter *
fileSyncOptions:FileSyncOptions -> FileSyncProvider
public function FileSyncProvider(
replicaId : Guid,
rootDirectoryPath : String,
scopeFilter : FileSyncScopeFilter,
fileSyncOptions : FileSyncOptions
)
Parameters
- replicaId
Type: System.Guid
The ID of the replica.
- 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 null reference (Nothing in Visual Basic).
- fileSyncOptions
Type: Microsoft.Synchronization.Files.FileSyncOptions
Flags that determine the behavior of the provider during synchronization. The default value is None.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | rootDirectoryPath is a null reference (Nothing in Visual Basic). |
| ArgumentException | replicaId is Empty, 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. |
Remarks
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 null reference (Nothing in Visual Basic). It names the metadata storage file filesync.metadata.