ReplicaMetadata.GetFilteredFullEnumerationChangeBatch Method

Gets a filtered change batch that contains item metadata for items that have IDs greater than or equal to the specified lower bound, as part of a full enumeration.

Namespace: Microsoft.Synchronization.MetadataStorage
Assembly: Microsoft.Synchronization.MetadataStorage (in microsoft.synchronization.metadatastorage.dll)

Syntax

'Declaration
Public MustOverride Function GetFilteredFullEnumerationChangeBatch ( _
    batchSize As UInteger, _
    filterInfo As FilterInfo, _
    filterCallback As ItemFilterCallback, _
    lowerEnumerationBound As SyncId, _
    destinationKnowledge As SyncKnowledge _
) As FullEnumerationChangeBatch
'Usage
Dim instance As ReplicaMetadata
Dim batchSize As UInteger
Dim filterInfo As FilterInfo
Dim filterCallback As ItemFilterCallback
Dim lowerEnumerationBound As SyncId
Dim destinationKnowledge As SyncKnowledge
Dim returnValue As FullEnumerationChangeBatch

returnValue = instance.GetFilteredFullEnumerationChangeBatch(batchSize, filterInfo, filterCallback, lowerEnumerationBound, destinationKnowledge)

public abstract FullEnumerationChangeBatch GetFilteredFullEnumerationChangeBatch (
    uint batchSize,
    FilterInfo filterInfo,
    ItemFilterCallback filterCallback,
    SyncId lowerEnumerationBound,
    SyncKnowledge destinationKnowledge
)

public:
virtual FullEnumerationChangeBatch^ GetFilteredFullEnumerationChangeBatch (
    unsigned int batchSize, 
    FilterInfo^ filterInfo, 
    ItemFilterCallback^ filterCallback, 
    SyncId^ lowerEnumerationBound, 
    SyncKnowledge^ destinationKnowledge
) abstract

public abstract FullEnumerationChangeBatch GetFilteredFullEnumerationChangeBatch (
    UInt32 batchSize, 
    FilterInfo filterInfo, 
    ItemFilterCallback filterCallback, 
    SyncId lowerEnumerationBound, 
    SyncKnowledge destinationKnowledge
)

public abstract function GetFilteredFullEnumerationChangeBatch (
    batchSize : uint, 
    filterInfo : FilterInfo, 
    filterCallback : ItemFilterCallback, 
    lowerEnumerationBound : SyncId, 
    destinationKnowledge : SyncKnowledge
) : FullEnumerationChangeBatch

Parameters

• batchSize
  The size of the change batch to return.

• filterInfo
  A FilterInfo object that represents information about a filter that is used to control which changes are included in a change batch.

• filterCallback
  An ReplicaMetadata.ItemFilterCallback object that is used to determine whether to include an item in a change batch.

• lowerEnumerationBound
  The lower bound for item IDs. This method returns changes with IDs greater than or equal to this ID value if they satisfy the filter criteria specified in filterInfo.

• destinationKnowledge
  The knowledge of the destination replica.

Return Value

A FullEnumerationChangeBatch object that contains the batch of changes.

See Also

Reference

ReplicaMetadata Class
ReplicaMetadata Members
Microsoft.Synchronization.MetadataStorage Namespace