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.
Assembly: Microsoft.Synchronization (in Microsoft.Synchronization.dll)
'Declaration Public Function GetChangeBatch ( _ batchSize As UInteger, _ destinationKnowledge As SyncKnowledge, _ filterInfo As FilterInfo, _ itemMetadataFilterDelegate As ItemMetadataFilter, _ <OutAttribute> ByRef changeDataRetriever As Object _ ) As ChangeBatch 'Usage Dim instance As FeedSyncServices Dim batchSize As UInteger Dim destinationKnowledge As SyncKnowledge Dim filterInfo As FilterInfo Dim itemMetadataFilterDelegate As ItemMetadataFilter Dim changeDataRetriever As Object Dim returnValue As ChangeBatch returnValue = instance.GetChangeBatch(batchSize, _ destinationKnowledge, filterInfo, _ itemMetadataFilterDelegate, 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 Nothing.
- itemMetadataFilterDelegate
- Type: Microsoft.Synchronization.FeedSync.ItemMetadataFilter
A delegate that is used to dynamically filter items added to the change batch. Can be a Nothing.
- 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.ChangeBatchA change batch that contains item metadata for items that are not contained in the specified knowledge from the destination provider.
| Exception | Condition |
|---|---|
| ArgumentNullException | destinationKnowledge is a Nothing. |
| 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 Nothing, the information is used to filter the items that are added to the change batch. If itemMetadataFilterDelegate is not a Nothing, the delegate is called one time before each item is added to the change batch.
Show: