SyncOperationStatistics Class

  • Article

Represents statistics about a bidirectional synchronization session.

Inheritance Hierarchy

System.Object
  Microsoft.Synchronization.SyncOperationStatistics

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

Syntax

'Declaration
<SerializableAttribute> _
Public Class SyncOperationStatistics
'Usage
Dim instance As SyncOperationStatistics

[SerializableAttribute]
public class SyncOperationStatistics

[SerializableAttribute]
public ref class SyncOperationStatistics

[<SerializableAttribute>]
type SyncOperationStatistics =  class end

public class SyncOperationStatistics

The SyncOperationStatistics type exposes the following members.

Properties

  Name Description
Public property DownloadChangesApplied Gets the total number of changes that were successfully applied during the download session.
Public property DownloadChangesFailed Gets the total number of changes that were not applied during the download session.
Public property DownloadChangesTotal Gets the total number of changes that were tried during the download session.
Public property SyncEndTime Gets or sets the date and time when the synchronization session ended.
Public property SyncStartTime Gets or sets the date and time when the synchronization session started.
Public property UploadChangesApplied Gets the total number of changes that were successfully applied during the upload session.
Public property UploadChangesFailed Gets the total number of changes that failed to apply during the upload session.
Public property UploadChangesTotal Gets the total number of changes that were tried during the upload session.

Top

Methods

  Name Description
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)

Top

Examples

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.
    Dim orchestrator As New SyncOrchestrator()
    orchestrator.LocalProvider = localProvider
    orchestrator.RemoteProvider = remoteProvider
    orchestrator.Direction = syncDir

    Dim msg As String
    Try
        ' Synchronize data between the two providers.
        Dim stats As SyncOperationStatistics = orchestrator.Synchronize()

        ' Display statistics for the synchronization operation.
        msg = ((("Synchronization succeeded!" & vbLf & vbLf & stats.DownloadChangesApplied & " download changes applied" & vbLf) & stats.DownloadChangesFailed & " download changes failed" & vbLf) & stats.UploadChangesApplied & " upload changes applied" & vbLf) & stats.UploadChangesFailed & " upload changes failed"
    Catch ex As Exception
        msg = "Synchronization failed! Here's why: " & vbLf & vbLf & ex.Message
    End Try
    MessageBox.Show(msg, "Synchronization Results")
End Sub

    // 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;
    try
    {
        // 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");
}

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.Synchronization Namespace