ChangeBatchBase Class

When overridden by a derived class, represents metadata for a set of changes.

Namespace:  Microsoft.Synchronization
Assembly:  Microsoft.Synchronization (in Microsoft.Synchronization.dll)

public abstract class ChangeBatchBase : IDisposable, 
	IEnumerable<ItemChange>, IEnumerable

The ChangeBatchBase type exposes the following members.

  NameDescription
Public propertyBatchWorkEstimateGets or sets the total work estimate for the change batch.
Public propertyCompatibilityLevelGets or sets the version of Sync Framework components that can be used with this object.
Public propertyStatic memberDefaultCompatibilityLevelGets or sets the default compatibility level of all ChangeBatchBase objects.
Public propertyDisposeAfterProcessingGets or sets a value that indicates whether the change batch object is disposed after processing finishes.
Public propertyFilterKeyMapGets or set the filter key map that contains the filters tracked by the replica that originated this change batch.
Public propertyIsEmptyGets a value that indicates whether the change batch contains any changes.
Public propertyIsLastBatchGets a value that indicates whether this is the last batch in the synchronization session.
Public propertyLearnedKnowledgeGets the knowledge that the destination replica learns when the destination provider applies all the changes in this change batch.
Public propertyPrerequisiteKnowledgeGets the minimum knowledge that a destination provider is required to have to process this change batch.
Public propertyRemainingSessionWorkEstimateGets or sets the remaining work estimate for the synchronization session.
Public propertySourceForgottenKnowledgeGets the forgotten knowledge of the source replica.
Top

  NameDescription
Public methodAddChangeAdds a specified item change to the group that is currently open
Public methodAddChangesAdds a specified set of item changes to the group that currently open
Public methodBeginOrderedGroupOpens an ordered group in the change batch. This group is ordered by item ID.
Public methodDispose()Releases all resources used by the ChangeBatchBase object.
Protected methodDispose(Boolean)Releases the unmanaged resources used by the ChangeBatchBase object and optionally releases the managed resources.
Public methodEndOrderedGroupCloses a previously opened ordered group in the change batch.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetEnumeratorGets an object that enumerates the item changes in this change batch. This method cannot be inherited.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodSerializeSerializes the change batch to an array of bytes.
Public methodSetFilterForgottenKnowledgeSets the filter forgotten knowledge for the specified filter.
Public methodSetLastBatchSets a value that indicates that this is the last batch in the synchronization session.
Protected methodThrowIfDisposedThrows ObjectDisposedException if this object has been disposed.
Public methodToString (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIEnumerable.GetEnumeratorGets an object that enumerates the item changes in this change batch.
Top

ChangeBatchBase is the base class for change batches. Sync Framework provides two classes that are derived from ChangeBatchBase. These are ChangeBatch for a knowledge synchronization and FullEnumerationChangeBatch for a full enumeration synchronization.

The members of IEnumerable are implemented explicitly. Code that accesses them must first cast the ChangeBatchBase object to the IEnumerable interface by using the casting operator or the as keyword.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: