ChangeApplicationServices.EndChangeApplication Method

  • Article

Ends processing of a set of changes.

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

Syntax

'Declaration
Public Function EndChangeApplication ( _
    batchLearnedKnowledge As SyncKnowledge _
) As SyncKnowledge
'Usage
Dim instance As ChangeApplicationServices
Dim batchLearnedKnowledge As SyncKnowledge
Dim returnValue As SyncKnowledge

returnValue = instance.EndChangeApplication(batchLearnedKnowledge)

public SyncKnowledge EndChangeApplication (
    SyncKnowledge batchLearnedKnowledge
)

public:
SyncKnowledge^ EndChangeApplication (
    SyncKnowledge^ batchLearnedKnowledge
)

public SyncKnowledge EndChangeApplication (
    SyncKnowledge batchLearnedKnowledge
)

public function EndChangeApplication (
    batchLearnedKnowledge : SyncKnowledge
) : SyncKnowledge

Parameters

  • batchLearnedKnowledge
    The learned knowledge of the change batch.

Return Value

Returns the updated destination knowledge, based on the changes that were applied or skipped.

Exceptions

Exception type Condition

ArgumentNullException

A required parameter is a null reference (Nothing in Visual Basic).

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.

Remarks

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.

Note

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.

See Also

Reference

ChangeApplicationServices Class
ChangeApplicationServices Members
Microsoft.Synchronization Namespace