FeedSyncServices.GetChangeBatch Method

Gets a change batch from the loaded FeedSync feed. The change batch contains item metadata for items that are not contained in the specified knowledge from the destination provider.

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

public ChangeBatch GetChangeBatch(
	uint batchSize,
	SyncKnowledge destinationKnowledge,
	FilterInfo filterInfo,
	ItemMetadataFilter itemMetadataFilterDelegate,
	out Object changeDataRetriever
)

Parameters

batchSize
Type: System.UInt32
The size of the batch to be created.
destinationKnowledge
Type: Microsoft.Synchronization.SyncKnowledge
The knowledge from the destination provider.
filterInfo
Type: Microsoft.Synchronization.FilterInfo
Filter information that is used to control which items are included in the change batch. Can be a null.
itemMetadataFilterDelegate
Type: Microsoft.Synchronization.FeedSync.ItemMetadataFilter
A delegate that is used to dynamically filter items added to the change batch. Can be a null.
changeDataRetriever
Type: System.Object%
Returns an object that can be used by the destination provider to retrieve item data from the source provider. The object can be an IChangeDataRetriever object or a provider-specific object.

Return Value

Type: Microsoft.Synchronization.ChangeBatch
A change batch that contains item metadata for items that are not contained in the specified knowledge from the destination provider.

ExceptionCondition
ArgumentNullException

destinationKnowledge is a null.

ArgumentException

batchSize is 0.

InvalidOperationException

Feed metadata was not previously loaded by calling LoadFeed.

This method helps a synchronization provider implement the GetChangeBatch method. If filterInfo is not a null, the information is used to filter the items that are added to the change batch. If itemMetadataFilterDelegate is not a null, the delegate is called one time before each item is added to the change batch.

Show: