Xceed .NET Libraries Documentation
Synchronize(FileSystemItem,SynchronizationOptions,Filter[],FileSystemItem[]) Method


Xceed.Synchronization Assembly > Xceed.Synchronization Namespace > Synchronizer Class > Synchronize Method : Synchronize(FileSystemItem,SynchronizationOptions,Filter[],FileSystemItem[]) Method
A value used to specify the Xceed.FileSystem.FileSystemItem that is the master item for the synchronization. The master item is the item that will be considered to be up to date and used to replace other items. Can be a null reference (Nothing in Visual Basic).
A SynchronizationOptions object representing the options to use during the synchronization process. Can be a null reference (Nothing in Visual Basic).
An array of Xceed.FileSystem.Filter objects, which will be used to filter the specified synchronization items. Can be a null reference (Nothing in Visual Basic).
The items to be synchronized.
Synchronizes the specified items.
Syntax
'Declaration
 
Public Overloads Shared Function Synchronize( _
   ByVal masterItem As FileSystemItem, _
   ByVal options As SynchronizationOptions, _
   ByVal filters() As Filter, _
   ByVal ParamArray items() As FileSystemItem _
) As SynchronizationResult
'Usage
 
Dim masterItem As FileSystemItem
Dim options As SynchronizationOptions
Dim filters() As Filter
Dim items() As FileSystemItem
Dim value As SynchronizationResult
 
value = Synchronizer.Synchronize(masterItem, options, filters, items)
public static SynchronizationResult Synchronize( 
   FileSystemItem masterItem,
   SynchronizationOptions options,
   Filter[] filters,
   params FileSystemItem[] items
)

Parameters

masterItem
A value used to specify the Xceed.FileSystem.FileSystemItem that is the master item for the synchronization. The master item is the item that will be considered to be up to date and used to replace other items. Can be a null reference (Nothing in Visual Basic).
options
A SynchronizationOptions object representing the options to use during the synchronization process. Can be a null reference (Nothing in Visual Basic).
filters
An array of Xceed.FileSystem.Filter objects, which will be used to filter the specified synchronization items. Can be a null reference (Nothing in Visual Basic).
items
The items to be synchronized.

Return Value

A SynchronizationResult value that specifies one or more results from the synchronization. The value is a set of flags. Typically, a value with the SynchronizationResult.ItemsSynchronized bit set indicates success; when the bit is not set, it means that no files were synchronized, indicating some kind of failure.

In success or failure, the other bit values of the SynchronizationResult enumeration give useful information on what did or did not happen during the synchronization.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

Reference

Synchronizer Class
Synchronizer Members
Overload List