SyncBatchProgress Class

Represents progress information, including conflict information, for a batch of changes during a synchronization session.

System.Object
  Microsoft.Synchronization.SyncBatchProgress

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

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

The SyncBatchProgress type exposes the following members.

  NameDescription
Public methodSyncBatchProgressInitializes a new instance of the SyncBatchProgress class by using batch number, batch count, more data, and progress parameters.
Top

  NameDescription
Public propertyBatchCountGets the total number of batches to synchronize during a session.
Public propertyBatchNumberGets the current batch number that the session is processing.
Public propertyMoreDataGets whether there are more changes to synchronize. This property always returns false in this version of the API.
Public propertyProgressGets a SyncGroupProgress object that the provider supplies, with detailed information about synchronization progress.
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

Sync Framework enables applications to download batches of changes to the client (batching is not supported on upload). Batching is enabled by specifying a value for the BatchSize property, and creating a command for the SelectNewAnchorCommand property that can return anchor values for each batch of changes. For more information, see How to: Specify the Order and Batch Size of Changes.

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: