SyncStatistics Class

Article
10/22/2010

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

Inheritance Hierarchy

System.Object
Microsoft.Synchronization.Data.SyncStatistics

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

Syntax

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

[SerializableAttribute]
public class SyncStatistics

[SerializableAttribute]
public ref class SyncStatistics

[<SerializableAttribute>]
type SyncStatistics =  class end

public class SyncStatistics

The SyncStatistics type exposes the following members.

Constructors

	Name	Description
	SyncStatistics	Initializes a new instance of the SyncStatistics class.

Top

Properties

	Name	Description
	DownloadChangesApplied	Gets or sets the number of changes downloaded from the server that were applied at the client.
	DownloadChangesFailed	Gets or sets the number of changes downloaded from the server that could not be applied at the client.
	SyncCompleteTime	Gets or sets the time when a SyncSession ended.
	SyncStartTime	Gets or sets the time when a SyncSession started.
	TotalChangesDownloaded	Gets or sets the total number of changes downloaded from the server. This includes the changes that could not be applied at the client.
	TotalChangesUploaded	Gets or sets the total number of changes uploaded from the client. This includes the changes that could not be applied at the server.
	UploadChangesApplied	Gets or sets the number of changes uploaded from the client that were applied at the server.
	UploadChangesFailed	Gets or sets the number of changes uploaded from the client that could not be applied at the server.

Top

Methods

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

Top

Remarks

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

Examples

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)

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.

Share via