ReplicaMetadata.GetFullEnumerationLocalVersions Method

When overridden in a derived class, gets a change batch that contains the versions of items and change units stored in this replica that correspond to the items and change units referred to in a batch of changes that are sent from some other provider, as part of a full enumeration.

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

Syntax

'Declaration
Public MustOverride Function GetFullEnumerationLocalVersions ( _
    sourceChanges As FullEnumerationChangeBatch _
) As IEnumerable(Of ItemChange)
'Usage
Dim instance As ReplicaMetadata
Dim sourceChanges As FullEnumerationChangeBatch
Dim returnValue As IEnumerable(Of ItemChange)

returnValue = instance.GetFullEnumerationLocalVersions(sourceChanges)
public abstract IEnumerable<ItemChange> GetFullEnumerationLocalVersions (
    FullEnumerationChangeBatch sourceChanges
)
public:
virtual IEnumerable<ItemChange^>^ GetFullEnumerationLocalVersions (
    FullEnumerationChangeBatch^ sourceChanges
) abstract
public abstract IEnumerable<ItemChange> GetFullEnumerationLocalVersions (
    FullEnumerationChangeBatch sourceChanges
)
public abstract function GetFullEnumerationLocalVersions (
    sourceChanges : FullEnumerationChangeBatch
) : IEnumerable<ItemChange>

Parameters

  • sourceChanges
    The batch of source changes about to be applied.

Return Value

A change batch that contains the versions of items and change units stored in this replica that correspond to the items and change units referred to in a batch of changes that are sent from some other provider, as part of a full enumeration.

Exceptions

Exception type Condition

ObjectDisposedException

The object has been disposed or was not initialized correctly.

ArgumentNullException

sourceChanges is a null reference (Nothing in Visual Basic).

Remarks

This method helps a synchronization provider implement its ProcessFullEnumerationChangeBatch method.

Change appliers use the versions in the batch of changes that are returned from this method for conflict detection.

Notes to Implementers: The change batch that is returned from this method must contain one entry for every item that has an item ID between the lower and upper bounds specified in sourceChanges, including change unit entries. If an item exists in the item store, its entry must contain its version information for this replica. If an item does not exist, its version must be set to SyncVersion.UnknownVersion and its P:Microsoft.Synchronization.ItemChange.ChangeKind property must be set to UnknownItem.

See Also

Reference

ReplicaMetadata Class
ReplicaMetadata Members
Microsoft.Synchronization.MetadataStorage Namespace