ChangeApplicationServices::EndChangeApplication Method

Ends processing of a set of changes.

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

public:
SyncKnowledge^ EndChangeApplication(
	SyncKnowledge^ batchLearnedKnowledge
)

Parameters

batchLearnedKnowledge
Type: Microsoft.Synchronization::SyncKnowledge
The learned knowledge of the change batch.

Return Value

Type: Microsoft.Synchronization::SyncKnowledge
Returns the updated destination knowledge, based on the changes that were applied or skipped.

ExceptionCondition
ArgumentNullException

A required parameter is a nullptr.

SyncIdFormatMismatchException

The ID format schema of the specified knowledge object does not match the ID format schema specified when this object was initialized.

SyncInvalidOperationException

Change application was not started.

The learned knowledge of the change batch, specified by batchLearnedKnowledge, is modified by this method to exclude any changes that were reported as skipped during change application.

The updated destination knowledge that is returned must replace the current knowledge of the destination replica.

NoteNote

When the updated destination knowledge is calculated, any changes that the destination provider did not reported as successfully applied by calling ReportItemChangeApplied or ReportChangeUnitChangeApplied are treated as having failed.

Show: