SyncBatchProgress Class
Represents progress information, including conflict information, for a batch of changes during a synchronization session.
Inheritance Hierarchy
System.Object
Microsoft.Synchronization.SyncBatchProgress
Namespace: Microsoft.Synchronization
Assembly: Microsoft.Synchronization.Data (in Microsoft.Synchronization.Data.dll)
Syntax
'Declaration
<SerializableAttribute> _
Public Class SyncBatchProgress
'Usage
Dim instance As SyncBatchProgress
[SerializableAttribute]
public class SyncBatchProgress
[SerializableAttribute]
public ref class SyncBatchProgress
[<SerializableAttribute>]
type SyncBatchProgress = class end
public class SyncBatchProgress
The SyncBatchProgress type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
SyncBatchProgress | Initializes a new instance of the SyncBatchProgress class by using batch number, batch count, more data, and progress parameters. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
BatchCount | Gets the total number of batches to synchronize during a session. |
|
BatchNumber | Gets the current batch number that the session is processing. |
|
MoreData | Gets whether there are more changes to synchronize. This property always returns false in this version of the API. |
|
Progress | Gets a SyncGroupProgress object that the provider supplies, with detailed information about synchronization progress. |
Top
Methods
| Name | Description | |
|---|---|---|
|
Equals | (Inherited from Object.) |
.gif "Protected method") |
Finalize | (Inherited from Object.) |
|
GetHashCode | (Inherited from Object.) |
|
GetType | (Inherited from Object.) |
|
MemberwiseClone | (Inherited from Object.) |
|
ToString | (Inherited from Object.) |
Top
Remarks
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.
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.