RelationalSyncProvider.GetFullEnumerationChangeBatch Method

Gets a batch of changes to synchronize when given batch size, lower bound, 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 GetFullEnumerationChangeBatch ( _
    batchSize As UInteger, _
    lowerEnumerationBound As SyncId, _
    knowledgeForDataRetrieval As SyncKnowledge, _
    <OutAttribute> ByRef changeDataRetriever As Object _
) As FullEnumerationChangeBatch
'Usage
Dim instance As RelationalSyncProvider
Dim batchSize As UInteger
Dim lowerEnumerationBound As SyncId
Dim knowledgeForDataRetrieval As SyncKnowledge
Dim changeDataRetriever As Object
Dim returnValue As FullEnumerationChangeBatch

returnValue = instance.GetFullEnumerationChangeBatch(batchSize, lowerEnumerationBound, knowledgeForDataRetrieval, changeDataRetriever)

public override FullEnumerationChangeBatch GetFullEnumerationChangeBatch (
    uint batchSize,
    SyncId lowerEnumerationBound,
    SyncKnowledge knowledgeForDataRetrieval,
    out Object changeDataRetriever
)

public:
virtual FullEnumerationChangeBatch^ GetFullEnumerationChangeBatch (
    unsigned int batchSize, 
    SyncId^ lowerEnumerationBound, 
    SyncKnowledge^ knowledgeForDataRetrieval, 
    [OutAttribute] Object^% changeDataRetriever
) override

public FullEnumerationChangeBatch GetFullEnumerationChangeBatch (
    UInt32 batchSize, 
    SyncId lowerEnumerationBound, 
    SyncKnowledge knowledgeForDataRetrieval, 
    /** @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.

• lowerEnumerationBound
  The point at which to start enumerating the batch of changes.

• knowledgeForDataRetrieval
  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