SyncOrchestrator.Cancel メソッド

現在の同期セッションをキャンセルします。

名前空間: Microsoft.Synchronization
アセンブリ: Microsoft.Synchronization (microsoft.synchronization.dll 内)

構文

'宣言
Public Sub Cancel
'使用
Dim instance As SyncOrchestrator

instance.Cancel
public void Cancel ()
public:
void Cancel ()
public void Cancel ()
public function Cancel ()

例外

例外の種類 条件

InvalidOperationException

StateDownloading または Uploading 以外の任意の値です。つまり、Cancel は各セッションで 1 回しか呼び出せないことに注意してください。

解説

このメソッドは、StateCanceling に設定します。

Cancel は、それ以降の処理が実行されないように同期セッションを停止します。既に実行された変更はロールバックされません。

Cancel が呼び出された後、すべての Sync Framework メソッドが SyncAbortedException をスローします。

参照

リファレンス

SyncOrchestrator クラス
SyncOrchestrator メンバ
Microsoft.Synchronization 名前空間