Share via


FullEnumerationChangeBatch Class

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

Inheritance Hierarchy

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

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

Syntax

'Declaration
<SerializableAttribute> _
Public NotInheritable Class FullEnumerationChangeBatch _
    Inherits ChangeBatchBase _
    Implements ISerializable
'Usage
Dim instance As FullEnumerationChangeBatch
[SerializableAttribute]
public sealed class FullEnumerationChangeBatch : ChangeBatchBase, 
    ISerializable
[SerializableAttribute]
public ref class FullEnumerationChangeBatch sealed : public ChangeBatchBase, 
    ISerializable
[<SealedAttribute>]
[<SerializableAttribute>]
type FullEnumerationChangeBatch =  
    class
        inherit ChangeBatchBase
        interface ISerializable
    end
public final class FullEnumerationChangeBatch extends ChangeBatchBase implements ISerializable

The FullEnumerationChangeBatch type exposes the following members.

Constructors

  Name Description
Public method FullEnumerationChangeBatch(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 method FullEnumerationChangeBatch(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

Properties

  Name Description
Public property BatchWorkEstimate Gets or sets the total work estimate for the change batch. (Inherited from ChangeBatchBase.)
Public property CompatibilityLevel Gets or sets the version of Sync Framework components that can be used with this object. (Inherited from ChangeBatchBase.)
Public property DestinationVersionEnumerationRangeLowerBound Gets the closed lower bound on item IDs that require destination versions.
Public property DestinationVersionEnumerationRangeUpperBound Gets the closed upper bound on item IDs that require destination versions.
Public property DisposeAfterProcessing Gets or sets a value that indicates whether the change batch object is disposed after processing finishes. (Inherited from ChangeBatchBase.)
Public property FilterKeyMap Gets or set the filter key map that contains the filters tracked by the replica that originated this change batch. (Inherited from ChangeBatchBase.)
Public property IsEmpty Gets a value that indicates whether the change batch contains any changes. (Inherited from ChangeBatchBase.)
Public property IsLastBatch Gets a value that indicates whether this is the last batch in the synchronization session. (Inherited from ChangeBatchBase.)
Public property LearnedForgottenKnowledge Gets the forgotten knowledge that the destination replica learns when the destination provider applies all the changes in this change batch during recovery synchronization.
Public property LearnedKnowledge Gets the knowledge that the destination replica learns when the destination provider applies all the changes in this change batch. (Inherited from ChangeBatchBase.)
Public property LearnedKnowledgeAfterFullEnumerationRecovery Gets the knowledge the destination replica will learn after it applies all the changes in the full enumeration.
Public property PrerequisiteKnowledge Gets the minimum knowledge that a destination provider is required to have to process this change batch. (Inherited from ChangeBatchBase.)
Public property RemainingSessionWorkEstimate Gets or sets the remaining work estimate for the synchronization session. (Inherited from ChangeBatchBase.)
Public property SourceForgottenKnowledge Gets the forgotten knowledge of the source replica. (Inherited from ChangeBatchBase.)

Top

Methods

  Name Description
Public method AddChange Adds a specified item change to the group that is currently open (Inherited from ChangeBatchBase.)
Public method AddChanges Adds a specified set of item changes to the group that currently open (Inherited from ChangeBatchBase.)
Public method BeginOrderedGroup Opens an ordered group in the change batch. This group is ordered by item ID. (Inherited from ChangeBatchBase.)
Public methodStatic member Deserialize(SyncIdFormatGroup, Byte[]) Creates a new FullEnumerationChangeBatch and initializes it by using serialized data.
Public methodStatic member Deserialize(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 method Dispose() Releases all resources used by the ChangeBatchBase object. (Inherited from ChangeBatchBase.)
Protected method Dispose(Boolean) Releases the unmanaged resources used by the ChangeBatchBase object and optionally releases the managed resources. (Inherited from ChangeBatchBase.)
Public method EndOrderedGroup Closes a previously opened ordered group in the change batch. (Inherited from ChangeBatchBase.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetEnumerator Gets an object that enumerates the item changes in this change batch. This method cannot be inherited. (Inherited from ChangeBatchBase.)
Public method GetHashCode (Inherited from Object.)
Public method GetObjectData Serializes the object data to a SerializationInfo object.
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Serialize Serializes the change batch to an array of bytes. (Inherited from ChangeBatchBase.)
Public method SetFilterForgottenKnowledge Sets the filter forgotten knowledge for the specified filter. (Inherited from ChangeBatchBase.)
Public method SetLastBatch Sets a value that indicates that this is the last batch in the synchronization session. (Inherited from ChangeBatchBase.)
Protected method ThrowIfDisposed Throws ObjectDisposedException if this object has been disposed. (Inherited from ChangeBatchBase.)
Public method ToString (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IEnumerable.GetEnumerator Gets an object that enumerates the item changes in this change batch. (Inherited from ChangeBatchBase.)

Top

Thread Safety

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

See Also

Reference

Microsoft.Synchronization Namespace

Other Resources

Recovering an Out-of-Date Replica