SyncAgent.SyncStatistics Property

Gets a SyncStatistics object that represents statistics for a synchronization session.

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

Syntax

'Declaration
Public ReadOnly Property SyncStatistics As SyncStatistics

public SyncStatistics SyncStatistics { get; }

public:
property SyncStatistics^ SyncStatistics {
    SyncStatistics^ get ();
}

/** @property */
public SyncStatistics get_SyncStatistics ()

public function get SyncStatistics () : SyncStatistics

Property Value

A SyncStatistics object that represents statistics for a synchronization session.

Remarks

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

Example

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: A Synchronization Services Application.

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.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements (Synchronization Services).

Target Platforms

See Also

Reference

SyncAgent Class
SyncAgent Members
Microsoft.Synchronization Namespace