RelationalSyncProvider::GetChangeBatch Method

Gets a batch of changes to synchronize when given batch size, destination knowledge, and change data retriever parameters.

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

public:
virtual ChangeBatch^ GetChangeBatch(
	unsigned int batchSize, 
	SyncKnowledge^ destinationKnowledge, 
	[OutAttribute] Object^% changeDataRetriever
) override

Parameters

batchSize
Type: System::UInt32
The number of changes to synchronize in each change batch.
destinationKnowledge
Type: Microsoft.Synchronization::SyncKnowledge
A SyncKnowledge object that contains the knowledge a provider has about the remote store at which changes are applied.
changeDataRetriever
Type: System::Object%
The object that will be used to retrieve the modified data.

Return Value

Type: Microsoft.Synchronization::ChangeBatch
A ChangeBatch object that contains the batch of changes to be synchronized.

ExceptionCondition
ArgumentNullException

destinationKnowledge is nullptr.

ObjectDisposedException

This RelationalSyncProvider is disposed.

DbOutdatedSyncException

The peer has outdated metadata.

Show: