UnmanagedSyncProviderWrapper::GetFullEnumerationChangeBatch Method

Gets a batch of changes from the unmanaged provider as part of a full enumeration.

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

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

Parameters

batchSize
Type: System::UInt32
The number of changes to include in the returned change batch.
lowerEnumerationBound
Type: Microsoft.Synchronization::SyncId
The closed lower bound for item IDs to enumerate. This method returns changes that have item IDs greater than or equal to this value.
knowledgeForDataRetrieval
Type: Microsoft.Synchronization::SyncKnowledge
A knowledge object that specifies items for which data is already known.
changeDataRetriever
Type: System::Object%
Returns an object that can be used to retrieve change data.

Return Value

Type: Microsoft.Synchronization::FullEnumerationChangeBatch
The batch of changes from the unmanaged provider.

ExceptionCondition
InvalidOperationException

This UnmanagedSyncProviderWrapper object is not initialized.

ArgumentNullException

lowerEnumerationBound or knowledgeForDataRetrieval is a nullptr.

This method wraps the unmanaged IKnowledgeSyncProvider::GetFullEnumerationChangeBatch method.

If a change data retriever adapter was specified, this method converts the change data retriever that is returned by the unmanaged provider to its managed representation before it returns changeDataRetriever. Otherwise, the change data retriever is just returned with no conversion.

Show: