Xceed .NET Libraries Documentation
Synchronize(FileSystemEvents,Object,SynchronizationEvents,Object,Filter[],FileSystemItem[]) Method


Xceed.Synchronization Assembly > Xceed.Synchronization Namespace > Synchronizer Class > Synchronize Method : Synchronize(FileSystemEvents,Object,SynchronizationEvents,Object,Filter[],FileSystemItem[]) Method
A Xceed.FileSystem.FileSystemEvents object that will be used to raise Xceed.FileSystem events. Can be a null reference (Nothing in Visual Basic).
Opaque data that is sent back to the event handler when a Xceed.FileSystem event is raised.
A SynchronizationEvents object that will be used to raise Xceed.Synchronization events. Can be a null reference (Nothing in Visual Basic).
Opaque data that is sent back to the event handler when a synchronization event is raised.
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 fileSystemEvents As FileSystemEvents, _
   ByVal fileSystemEventsUserData As Object, _
   ByVal synchronizationEvents As SynchronizationEvents, _
   ByVal synchronizationEventsUserData As Object, _
   ByVal filters() As Filter, _
   ByVal ParamArray items() As FileSystemItem _
) As SynchronizationResult
'Usage
 
Dim fileSystemEvents As FileSystemEvents
Dim fileSystemEventsUserData As Object
Dim synchronizationEvents As SynchronizationEvents
Dim synchronizationEventsUserData As Object
Dim filters() As Filter
Dim items() As FileSystemItem
Dim value As SynchronizationResult
 
value = Synchronizer.Synchronize(fileSystemEvents, fileSystemEventsUserData, synchronizationEvents, synchronizationEventsUserData, filters, items)

Parameters

fileSystemEvents
A Xceed.FileSystem.FileSystemEvents object that will be used to raise Xceed.FileSystem events. Can be a null reference (Nothing in Visual Basic).
fileSystemEventsUserData
Opaque data that is sent back to the event handler when a Xceed.FileSystem event is raised.
synchronizationEvents
A SynchronizationEvents object that will be used to raise Xceed.Synchronization events. Can be a null reference (Nothing in Visual Basic).
synchronizationEventsUserData
Opaque data that is sent back to the event handler when a synchronization event is raised.
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