Share via

DbSyncProvider.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.  The CLS-compliant alternative is .

Namespace: Microsoft.Synchronization.Data
Assembly: Microsoft.Synchronization.Data (in microsoft.synchronization.data.dll)

Syntax

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

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

[CLSCompliantAttribute(false)] 
public override ChangeBatch GetChangeBatch (
    uint batchSize,
    SyncKnowledge destinationKnowledge,
    out Object changeDataRetriever
)

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

/** @attribute CLSCompliantAttribute(false) */ 
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.

Remarks

Microsoft.Synchronization.dll and associated concepts about synchronization knowledge are documented in the Sync Framework core documentation. To download this documentation, go to this Microsoft Web site.

See Also

Reference

DbSyncProvider Class
DbSyncProvider Members
Microsoft.Synchronization.Data Namespace