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)

Syntax

'Declaration
Public Overrides Function GetChangeBatch ( _
    batchSize As UInteger, _
    destinationKnowledge As SyncKnowledge, _
    <OutAttribute> ByRef changeDataRetriever As Object _
) As ChangeBatch
'Usage
Dim instance As RelationalSyncProvider
Dim batchSize As UInteger
Dim destinationKnowledge As SyncKnowledge
Dim changeDataRetriever As Object
Dim returnValue As ChangeBatch

returnValue = instance.GetChangeBatch(batchSize, _
    destinationKnowledge, changeDataRetriever)

public override ChangeBatch GetChangeBatch(
    uint batchSize,
    SyncKnowledge destinationKnowledge,
    out Object changeDataRetriever
)

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

abstract GetChangeBatch : 
        batchSize:uint32 * 
        destinationKnowledge:SyncKnowledge * 
        changeDataRetriever:Object byref -> ChangeBatch 
override GetChangeBatch : 
        batchSize:uint32 * 
        destinationKnowledge:SyncKnowledge * 
        changeDataRetriever:Object byref -> ChangeBatch 

public override function GetChangeBatch(
    batchSize : uint, 
    destinationKnowledge : SyncKnowledge, 
    changeDataRetriever : Object
) : ChangeBatch

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.

Exceptions

See Also

Reference

RelationalSyncProvider Class

Microsoft.Synchronization.Data Namespace