KnowledgeSyncProvider.GetChangeBatch Method

When overridden in a derived class, gets a change batch that contains item metadata for items that are not contained in the specified knowledge from the destination provider.

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

Syntax

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

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

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

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

public abstract 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 include in the change batch.

• destinationKnowledge
  The knowledge from the destination provider. This knowledge must be mapped by calling MapRemoteKnowledgeToLocal on the source knowledge before it can be used for change enumeration.

• changeDataRetriever
  Returns an object that can be used to retrieve change data. It can be an IChangeDataRetriever object or a provider-specific object.

Return Value

A change batch that contains item metadata for items that are not contained in the specified knowledge from the destination provider. Cannot be a null reference (Nothing in Visual Basic).

Remarks

The same change will not appear in multiple batches.

If fewer changes than the number specified by batchSize remain, a smaller batch will be returned.

If this method is called when no changes remain, it throws InvalidOperationException.

Notes to Implementers: If there are no more changes to send after this batch, IsLastBatch must be set to true on the returned change batch. Otherwise, Sync Framework calls GetChangeBatch again to retrieve another batch of changes.

See Also

Reference

KnowledgeSyncProvider Class
KnowledgeSyncProvider Members
Microsoft.Synchronization Namespace