FeedSyncServices.GetChangeBatch Method

  • Article

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)

Syntax

'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)

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

public:
ChangeBatch^ GetChangeBatch(
    unsigned int batchSize, 
    SyncKnowledge^ destinationKnowledge, 
    FilterInfo^ filterInfo, 
    ItemMetadataFilter^ itemMetadataFilterDelegate, 
    [OutAttribute] Object^% changeDataRetriever
)

member GetChangeBatch : 
        batchSize:uint32 * 
        destinationKnowledge:SyncKnowledge * 
        filterInfo:FilterInfo * 
        itemMetadataFilterDelegate:ItemMetadataFilter * 
        changeDataRetriever:Object byref -> ChangeBatch 

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

Parameters

  • batchSize
    Type: System.UInt32
    The size of the batch to be created.
  • filterInfo
    Type: Microsoft.Synchronization.FilterInfo
    Filter information that is used to control which items are included in the change batch. Can be a null reference (Nothing in Visual Basic).
  • 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.

Exceptions

Exception Condition
ArgumentNullException

destinationKnowledge is a null reference (Nothing in Visual Basic).
ArgumentException

batchSize is 0.
InvalidOperationException

Feed metadata was not previously loaded by calling LoadFeed.

Remarks

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

See Also

Reference

FeedSyncServices Class

Microsoft.Synchronization.FeedSync Namespace