FullEnumerationChangeBatch Class

Represents metadata for a set of changes for a full enumeration. This class cannot be inherited.

System.Object
  Microsoft.Synchronization.ChangeBatchBase
    Microsoft.Synchronization.FullEnumerationChangeBatch

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

[SerializableAttribute]
public sealed class FullEnumerationChangeBatch : ChangeBatchBase, 
	ISerializable

The FullEnumerationChangeBatch type exposes the following members.

  NameDescription
Public methodFullEnumerationChangeBatch(SyncIdFormatGroup, SyncKnowledge, ForgottenKnowledge, SyncId)Initializes a new instance of the FullEnumerationChangeBatch class that contains the specified ID format schema, the knowledge from the destination provider, forgotten knowledge from the source provider, and the closed lower bound of the range of item IDs to enumerate.
Public methodFullEnumerationChangeBatch(SyncIdFormatGroup, SyncKnowledge, ForgottenKnowledge, SyncId, FilterInfo)Initializes a new instance of the FullEnumerationChangeBatch class that contains the specified ID format schema, the knowledge from the destination provider, forgotten knowledge from the source provider, the closed lower bound of the range of item IDs to enumerate, and the filter that is used to control which changes are included in the change batch.
Top

  NameDescription
Public propertyBatchWorkEstimateGets or sets the total work estimate for the change batch. (Inherited from ChangeBatchBase.)
Public propertyCompatibilityLevelGets or sets the version of Sync Framework components that can be used with this object. (Inherited from ChangeBatchBase.)
Public propertyDestinationVersionEnumerationRangeLowerBoundGets the closed lower bound on item IDs that require destination versions.
Public propertyDestinationVersionEnumerationRangeUpperBoundGets the closed upper bound on item IDs that require destination versions.
Public propertyDisposeAfterProcessingGets or sets a value that indicates whether the change batch object is disposed after processing finishes. (Inherited from ChangeBatchBase.)
Public propertyFilterKeyMapGets or set the filter key map that contains the filters tracked by the replica that originated this change batch. (Inherited from ChangeBatchBase.)
Public propertyIsEmptyGets a value that indicates whether the change batch contains any changes. (Inherited from ChangeBatchBase.)
Public propertyIsLastBatchGets a value that indicates whether this is the last batch in the synchronization session. (Inherited from ChangeBatchBase.)
Public propertyLearnedForgottenKnowledgeGets the forgotten knowledge that the destination replica learns when the destination provider applies all the changes in this change batch during recovery synchronization.
Public propertyLearnedKnowledgeGets the knowledge that the destination replica learns when the destination provider applies all the changes in this change batch. (Inherited from ChangeBatchBase.)
Public propertyLearnedKnowledgeAfterFullEnumerationRecoveryGets the knowledge the destination replica will learn after it applies all the changes in the full enumeration.
Public propertyPrerequisiteKnowledgeGets the minimum knowledge that a destination provider is required to have to process this change batch. (Inherited from ChangeBatchBase.)
Public propertyRemainingSessionWorkEstimateGets or sets the remaining work estimate for the synchronization session. (Inherited from ChangeBatchBase.)
Public propertySourceForgottenKnowledgeGets the forgotten knowledge of the source replica. (Inherited from ChangeBatchBase.)
Top

  NameDescription
Public methodAddChangeAdds a specified item change to the group that is currently open (Inherited from ChangeBatchBase.)
Public methodAddChangesAdds a specified set of item changes to the group that currently open (Inherited from ChangeBatchBase.)
Public methodBeginOrderedGroupOpens an ordered group in the change batch. This group is ordered by item ID. (Inherited from ChangeBatchBase.)
Public methodStatic memberDeserialize(SyncIdFormatGroup, Byte[])Creates a new FullEnumerationChangeBatch and initializes it by using serialized data.
Public methodStatic memberDeserialize(SyncIdFormatGroup, ISyncFilterDeserializer, Byte[])Static method that creates a change batch object that is used for recovery synchronization, and initializes it by using an ID format schema, a custom filter deserializer, and data from a byte array.
Public methodDispose()Releases all resources used by the ChangeBatchBase object. (Inherited from ChangeBatchBase.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the ChangeBatchBase object and optionally releases the managed resources. (Inherited from ChangeBatchBase.)
Public methodEndOrderedGroupCloses a previously opened ordered group in the change batch. (Inherited from ChangeBatchBase.)
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. (Inherited from ChangeBatchBase.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetObjectDataSerializes the object data to a SerializationInfo object.
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodSerializeSerializes the change batch to an array of bytes. (Inherited from ChangeBatchBase.)
Public methodSetFilterForgottenKnowledgeSets the filter forgotten knowledge for the specified filter. (Inherited from ChangeBatchBase.)
Public methodSetLastBatchSets a value that indicates that this is the last batch in the synchronization session. (Inherited from ChangeBatchBase.)
Protected methodThrowIfDisposedThrows ObjectDisposedException if this object has been disposed. (Inherited from ChangeBatchBase.)
Public methodToString (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIEnumerable.GetEnumeratorGets an object that enumerates the item changes in this change batch. (Inherited from ChangeBatchBase.)
Top

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: