ChangeApplicationServices::BeginChangeApplication Method

Begins processing of a set of changes.

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

public:
void BeginChangeApplication(
	SyncKnowledge^ destinationKnowledge, 
	ForgottenKnowledge^ destinationForgottenKnowledge, 
	FilterInfo^ filterInfo, 
	SyncCallbacks^ syncCallbacks, 
	IChangeDataRetriever^ sourceDataRetriever, 
	IChangeDataRetriever^ destinationDataRetriever
)

Parameters

destinationKnowledge
Type: Microsoft.Synchronization::SyncKnowledge
The current knowledge of the destination replica.
destinationForgottenKnowledge
Type: Microsoft.Synchronization::ForgottenKnowledge
The current forgotten knowledge of the destination replica. Can be a nullptr.
filterInfo
Type: Microsoft.Synchronization::FilterInfo
Information about filters used by the destination provider. Can be a nullptr.
syncCallbacks
Type: Microsoft.Synchronization::SyncCallbacks
Callbacks that will receive notifications about change application events. Can be a nullptr.
sourceDataRetriever
Type: Microsoft.Synchronization::IChangeDataRetriever
An object that can be used to retrieve item data from the source replica.
destinationDataRetriever
Type: Microsoft.Synchronization::IChangeDataRetriever
An object that can be used to retrieve item data from the destination replica.

ExceptionCondition
ArgumentNullException

destinationKnowledge, sourceDataRetriever, or destinationDataRetriever is a nullptr.

SyncIdFormatMismatchException

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

SyncInvalidOperationException

The change application was started but not ended on another set of changes.

This method is typically called one time for each batch of changes that is received by the ProcessChangeBatch method of the destination provider.

This method must be called before knowledge can be set or calculated, or changes applied or reported.

Show: