ChangeApplicationServices.BeginChangeApplication Method

Begins processing of a set of changes.

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

Syntax

'Declaration
Public Sub BeginChangeApplication ( _
    destinationKnowledge As SyncKnowledge, _
    destinationForgottenKnowledge As ForgottenKnowledge, _
    filterInfo As FilterInfo, _
    syncCallbacks As SyncCallbacks, _
    sourceDataRetriever As IChangeDataRetriever, _
    destinationDataRetriever As IChangeDataRetriever _
)
'Usage
Dim instance As ChangeApplicationServices
Dim destinationKnowledge As SyncKnowledge
Dim destinationForgottenKnowledge As ForgottenKnowledge
Dim filterInfo As FilterInfo
Dim syncCallbacks As SyncCallbacks
Dim sourceDataRetriever As IChangeDataRetriever
Dim destinationDataRetriever As IChangeDataRetriever

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

Parameters

  • destinationKnowledge
    The current knowledge of the destination replica.
  • destinationForgottenKnowledge
    The current forgotten knowledge of the destination replica. Can be a null reference (Nothing in Visual Basic).
  • filterInfo
    Information about filters used by the destination provider. Can be a null reference (Nothing in Visual Basic).
  • syncCallbacks
    Callbacks that will receive notifications about change application events. Can be a null reference (Nothing in Visual Basic).
  • sourceDataRetriever
    An object that can be used to retrieve item data from the source replica.
  • destinationDataRetriever
    An object that can be used to retrieve item data from the destination replica.

Exceptions

Exception type Condition

ArgumentNullException

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

SyncIdFormatMismatchException

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

SyncInvalidOperationException

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

Remarks

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.

See Also

Reference

ChangeApplicationServices Class
ChangeApplicationServices Members
Microsoft.Synchronization Namespace