SyncOrchestrator.Synchronize Method

Starts a synchronization session.

Namespace: Microsoft.Synchronization
Assembly: Microsoft.Synchronization (in microsoft.synchronization.dll)

public SyncOperationStatistics Synchronize ()
public SyncOperationStatistics Synchronize ()
public function Synchronize () : SyncOperationStatistics

Return Value

Statistics about the synchronization session.

The synchronization that this method performs will be one-way or two-way, depending on the value of Direction.

When this method is called, neither LocalProvider nor RemoteProvider can be a null reference (Nothing in Visual Basic).

This method sets State to correspond to the value of Direction.

The following example synchronizes data between two providers and displays the synchronization statistics to the user.

    // Create the synchronization orchestrator and set the providers and synchronization direction.
    SyncOrchestrator orchestrator = new SyncOrchestrator();
    orchestrator.LocalProvider = localProvider;
    orchestrator.RemoteProvider = remoteProvider;
    orchestrator.Direction = syncDir;

    string msg;
        // Synchronize data between the two providers.
        SyncOperationStatistics stats = orchestrator.Synchronize();

        // Display statistics for the synchronization operation.
        msg = "Synchronization succeeded!\n\n" +
            stats.DownloadChangesApplied + " download changes applied\n" +
            stats.DownloadChangesFailed + " download changes failed\n" +
            stats.UploadChangesApplied + " upload changes applied\n" +
            stats.UploadChangesFailed + " upload changes failed";
    catch (Exception ex)
        msg = "Synchronization failed! Here's why: \n\n" + ex.Message;
    MessageBox.Show(msg, "Synchronization Results");