IFileSyncProvider インターフェイス

NTFS、FAT、または SMB ファイル システムのファイル、フォルダー、およびサブフォルダーの同期に使用できる、同期フィルター処理済みの同期プロバイダーです。

interface IFileSyncProvider : IKnowledgeSyncProvider

メンバー

IFileSyncProvider メソッド 説明

IFileSyncProvider::Initialize

同期するフォルダーとその他の設定に基づく IFileSyncProvider の新しいインスタンスを初期化します。

IFileSyncProvider::DetectChanges

変更のためローカル ファイル システムのレプリカの列挙体をトリガーし、メタデータを適切に更新します。

IFileSyncProvider::SetPreviewMode

プロバイダーがプレビュー モードであるかどうかを示す値を設定します。

IFileSyncProvider::CreateNewScopeFilter

新しい IFileSyncScopeFilter オブジェクトを作成します。このオブジェクトは、フィルターのプロパティの設定後に Initialize に渡すことができます。

解説

ディレクトリ内のすべてのファイルおよびサブフォルダーを同期するには、レプリカ ID およびルート ディレクトリを IFileSyncProvider::Initialize に渡し、プロバイダーを IApplicationSyncServices::CreateSyncSession に渡し、返された ISyncSession オブジェクトを使用して同期セッションを処理します。

既定では、同期メタデータは、レプリカのルート ディレクトリにある Metadata Storage Service データベース ファイルに格納されます。このファイルの場所および名前をカスタマイズするには、Initialize を使用して指定します。

どのファイルおよびフォルダーを同期スコープに含めるかを管理するには、IFileSyncScopeFilter オブジェクトを構成し、それを Initialize に渡します。フィルターには、ファイルやフォルダーの一覧を除外したり、属性に基づいてファイルおよびフォルダーを除外したり、ファイルの一覧を明示的に含めたりする場合に使用できるプロパティが含まれています。

構成オプション FILESYNC_INIT_FLAGS を使用して、同期時のプロバイダーの動作を制御できます。たとえば、削除したファイルをごみ箱に移動するのか、またはファイル システムから完全に削除するのかを指定できます。

アプリケーションでさまざまなイベントを使用し、進行状況を表示したり、セッション時に特定の変更を動的にスキップしたりすることができます。

同期を開始する前に TRUEIFileSyncProvider::SetPreviewMode に渡して、プロバイダーをプレビュー モードにできます。プレビュー モードでは、すべてのイベントの発生も含め、実際の同期セッションと同様にすべてのアクションがプロバイダーで実行されます。ただしプロバイダーは、同期先レプリカへの変更の適用は行いません。

注意

同じファイル ストアへの同時的な同期処理はサポートされていません。別のプロバイダー インスタンスが同じレプリカで先に初期化されたが (つまり、ディレクトリ パスとメタデータ ファイル パスが同じ値の場合)、まだ解放されていない場合は、Initialize によって SYNC_METADATA_E_REPLICA_IN_USE が返されます。

必要条件

ヘッダー: FileSyncProvider.h

参照

概念

Sync Framework のファイル同期コンポーネント