Share via


ISyncChangeBatchBase Interface

Represents metadata for a set of changes.

interface ISyncChangeBatchBase : IUnknown

Members

ISyncChangeBatchBase methods Description

ISyncChangeBatchBase::GetChangeEnumerator

Gets an IEnumSyncChanges object that enumerates the item changes in this change batch.

ISyncChangeBatchBase::GetIsLastBatch

Gets a flag that indicates whether the changes in this change batch are the last batch of a synchronization session.

ISyncChangeBatchBase::GetWorkEstimateForBatch

Gets the work estimate for the batch.

ISyncChangeBatchBase::GetRemainingWorkEstimateForSession

Gets the estimate of the remaining work for the session.

ISyncChangeBatchBase::BeginOrderedGroup

Opens an ordered group in the change batch. This group is ordered by item ID.

ISyncChangeBatchBase::EndOrderedGroup

Closes a previously opened ordered group in the change batch.

ISyncChangeBatchBase::AddItemMetadataToGroup

Adds a specified item change to the group that is currently open.

ISyncChangeBatchBase::GetLearnedKnowledge

Gets the knowledge that the destination replica learns when the destination provider applies the changes in this change batch.

ISyncChangeBatchBase::GetPrerequisiteKnowledge

Gets the minimum knowledge that a destination provider is required to have to process this change batch.

ISyncChangeBatchBase::GetSourceForgottenKnowledge

Gets the forgotten knowledge of the source replica.

ISyncChangeBatchBase::SetLastBatch

Sets a flag that indicates there are no more changes to be enumerated in the synchronization session.

ISyncChangeBatchBase::SetWorkEstimateForBatch

Sets the work estimate for the session.

ISyncChangeBatchBase::SetRemainingWorkEstimateForSession

Sets the estimate of the remaining work for the batch.

ISyncChangeBatchBase::Serialize

Serializes the change batch to an array of bytes.

Remarks

ISyncChangeBatchBase is the base interface for change batches. Typically, it is overridden by a derived interface, such as ISyncChangeBatch for a knowledge synchronization, and ISyncFullEnumerationChangeBatch for a full enumeration synchronization.

Requirements

Header: Synchronization.h

See Also

Concepts

Sync Framework Core Components