RelationalSyncProvider.GetFullEnumerationChangeBatch Method
Gets a batch of changes to synchronize when given batch size, lower bound, knowledge, and change data retriever parameters.
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
abstract GetFullEnumerationChangeBatch :
batchSize:uint32 *
lowerEnumerationBound:SyncId *
knowledgeForDataRetrieval:SyncKnowledge *
changeDataRetriever:Object byref -> FullEnumerationChangeBatch
override GetFullEnumerationChangeBatch :
batchSize:uint32 *
lowerEnumerationBound:SyncId *
knowledgeForDataRetrieval:SyncKnowledge *
changeDataRetriever:Object byref -> FullEnumerationChangeBatch
public override function GetFullEnumerationChangeBatch(
batchSize : uint,
lowerEnumerationBound : SyncId,
knowledgeForDataRetrieval : SyncKnowledge,
changeDataRetriever : Object
) : FullEnumerationChangeBatch
Parameters
- batchSize
Type: System.UInt32
The number of changes to synchronize in each change batch.
- lowerEnumerationBound
Type: Microsoft.Synchronization.SyncId
The point at which to start enumerating the batch of changes.
- knowledgeForDataRetrieval
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.FullEnumerationChangeBatch
A ChangeBatch object that contains the batch of changes to be synchronized.