SyncOrchestrator.Cancel Method

Cancels the current synchronization session.

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

Syntax

'Declaration
Public Sub Cancel
'Usage
Dim instance As SyncOrchestrator

instance.Cancel()

public void Cancel()

public:
void Cancel()

member Cancel : unit -> unit 

public function Cancel()

Exceptions

Exception	Condition
InvalidOperationException	State is any value other than Downloading or Uploading. Be aware that this means Cancel can only be called one time for each session.

Remarks

This method sets State to Canceling.

Cancel stops the synchronization session from performing any more work. It does not roll back any changes that have already been made.

After Cancel is called, all Sync Framework methods throw SyncAbortedException.

See Also

Reference

SyncOrchestrator Class

Microsoft.Synchronization Namespace