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 ReplicaMetadata..::..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 ReplicaMetadata..::..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,
    ReplicaMetadata..::..ItemFilterCallback filterCallback,
    SyncId lowerEnumerationBound,
    SyncKnowledge destinationKnowledge
)

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

abstract GetFilteredFullEnumerationChangeBatch : 
        batchSize:uint32 * 
        filterInfo:FilterInfo * 
        filterCallback:ReplicaMetadata..::..ItemFilterCallback * 
        lowerEnumerationBound:SyncId * 
        destinationKnowledge:SyncKnowledge -> FullEnumerationChangeBatch 

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

Parameters

• batchSize
  Type: System.UInt32
  The size of the change batch to return.

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

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

• lowerEnumerationBound
  Type: Microsoft.Synchronization.SyncId
  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
  Type: Microsoft.Synchronization.SyncKnowledge
  The knowledge of the destination replica.

Return Value

Type: Microsoft.Synchronization.FullEnumerationChangeBatch
A FullEnumerationChangeBatch object that contains the batch of changes.

See Also

Reference

ReplicaMetadata Class

Microsoft.Synchronization.MetadataStorage Namespace