SyncStatistics Class

Represents a summary of a SyncSession with regard to the total number of operations that occurred on the client and server.

System.Object
  Microsoft.Synchronization.Data.SyncStatistics

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

[SerializableAttribute]
public class SyncStatistics

The SyncStatistics type exposes the following members.

  NameDescription
Public methodSyncStatisticsInitializes a new instance of the SyncStatistics class.
Top

  NameDescription
Public propertyDownloadChangesAppliedGets or sets the number of changes downloaded from the server that were applied at the client.
Public propertyDownloadChangesFailedGets or sets the number of changes downloaded from the server that could not be applied at the client.
Public propertySyncCompleteTimeGets or sets the time when a SyncSession ended.
Public propertySyncStartTimeGets or sets the time when a SyncSession started.
Public propertyTotalChangesDownloadedGets or sets the total number of changes downloaded from the server. This includes the changes that could not be applied at the client.
Public propertyTotalChangesUploadedGets or sets the total number of changes uploaded from the client. This includes the changes that could not be applied at the server.
Public propertyUploadChangesAppliedGets or sets the number of changes uploaded from the client that were applied at the server.
Public propertyUploadChangesFailedGets or sets the number of changes uploaded from the client that could not be applied at the server.
Top

  NameDescription
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString (Inherited from Object.)
Top

Synchronization statistics are useful for logging and for presenting summary data to a user after a synchronization session is complete.

The following code examples call the Synchronize method of a class that derives from SyncAgent, and then write information to the console. To view this code in the context of a complete example, see Getting Started: Client and Server Synchronization.

SampleSyncAgent sampleSyncAgent = new SampleSyncAgent();
SyncStatistics syncStatistics = sampleSyncAgent.Synchronize();


Console.WriteLine("Start Time: " + syncStatistics.SyncStartTime);
Console.WriteLine("Total Changes Downloaded: " + syncStatistics.TotalChangesDownloaded);
Console.WriteLine("Complete Time: " + syncStatistics.SyncCompleteTime);
Console.WriteLine(String.Empty);


Dim sampleSyncAgent As New SampleSyncAgent()
Dim syncStatistics As SyncStatistics = sampleSyncAgent.Synchronize()


Console.WriteLine("Start Time: " & syncStatistics.SyncStartTime)
Console.WriteLine("Total Changes Downloaded: " & syncStatistics.TotalChangesDownloaded)
Console.WriteLine("Complete Time: " & syncStatistics.SyncCompleteTime)
Console.WriteLine(String.Empty)


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