Share via

RelationalSyncProvider.GetChangeBatch Method

  • Article

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

This method is not CLS-compliant.  

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

public ChangeBatch GetChangeBatch (
    UInt32 batchSize, 
    SyncKnowledge destinationKnowledge, 
    /** @attribute OutAttribute() */ /** @ref */ Object changeDataRetriever
)

JScript does not support passing value-type arguments by reference.

Parameters

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

Return Value

A ChangeBatch object that contains the batch of changes to be synchronized.

See Also

Reference

RelationalSyncProvider Class
RelationalSyncProvider Members
Microsoft.Synchronization.Data Namespace