'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 masterItemIndex As Integer, _ 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 masterItemIndex As Integer Dim items() As FileSystemItem Dim value As SynchronizationResult value = Synchronizer.Synchronize(fileSystemEvents, fileSystemEventsUserData, synchronizationEvents, synchronizationEventsUserData, filters, masterItemIndex, items)
public static SynchronizationResult Synchronize( FileSystemEvents fileSystemEvents, object fileSystemEventsUserData, SynchronizationEvents synchronizationEvents, object synchronizationEventsUserData, Filter[] filters, int masterItemIndex, params FileSystemItem[] 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).
- masterItemIndex
- A value used to specify the index of 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.
- 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.