ISyncChangeBatchBase interface (winsync.h)
Represents metadata for a set of changes.
Inheritance
The ISyncChangeBatchBase interface inherits from the IUnknown interface. ISyncChangeBatchBase also has these types of members:
Methods
The ISyncChangeBatchBase interface has these methods.
| ISyncChangeBatchBase::AddItemMetadataToGroup Adds a specified item change to the group that is currently open. |
| 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::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::GetLearnedKnowledge Gets the knowledge that the destination replica learns when the destination provider applies all 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::GetRemainingWorkEstimateForSession Gets the estimate of the remaining work for the session. |
| ISyncChangeBatchBase::GetSourceForgottenKnowledge Gets the forgotten knowledge of the source replica. |
| ISyncChangeBatchBase::GetWorkEstimateForBatch Gets the work estimate for the batch. |
| ISyncChangeBatchBase::Serialize Serializes the change batch to an array of bytes. |
| ISyncChangeBatchBase::SetLastBatch Sets a flag that indicates there are no more changes to be enumerated in the synchronization session. |
| ISyncChangeBatchBase::SetRemainingWorkEstimateForSession Sets the estimate of the remaining work for the session. |
| ISyncChangeBatchBase::SetWorkEstimateForBatch Sets the work estimate for the batch. |
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
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 7 [desktop apps only] |
| Minimum supported server | Windows Server 2008 R2 [desktop apps only] |
| Target Platform | Windows |
| Header | winsync.h |
See also
ISyncChangeBatchAdvanced Interface
ISyncChangeBatchBase2 Interface
ISyncChangeBatchWithPrerequisite Interface
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for