CleanupMetadata 方法

命名空间:  Microsoft.Synchronization.Data
程序集:  Microsoft.Synchronization.Data(在 Microsoft.Synchronization.Data.dll 中)

语法

声明
Public Overridable Function CleanupMetadata As Boolean
用法
Dim instance As DbSyncProvider
Dim returnValue As Boolean

returnValue = instance.CleanupMetadata()
public virtual bool CleanupMetadata()
public:
virtual bool CleanupMetadata()
abstract CleanupMetadata : unit -> bool 
override CleanupMetadata : unit -> bool 
public function CleanupMetadata() : boolean

返回值

类型:System. . :: . .Boolean
如果成功地运行了元数据清除,则为 true;否则为 false。

异常

异常 条件
ObjectDisposedException

DbSyncProvider 已释放。

示例

下面的代码示例调用 CleanupMetadata 方法。该代码对提供程序进行实例化,并调用 SampleSyncProvider 类中的 ConfigureDbSyncProvider 方法。所有所需的 DbSyncAdapterDbSyncProvider 属性均在此类中定义。其中包括 SelectMetadataForCleanupCommand 属性。传递给 ConfigureDbSyncProvider 方法的值 7 是以天为单位的元数据保持期。

sampleSyncProvider = new SampleSyncProvider();
DbSyncProvider provider1 = sampleSyncProvider.ConfigureDbSyncProvider(Utility.ConnStr_DbSync1, 7);

if (provider1.CleanupMetadata() == true)
{
    Console.WriteLine(String.Empty);
    Console.WriteLine("Metadata cleanup ran in the SyncSamplesDb_Peer1 database.");
    Console.WriteLine("Metadata more than 7 days old was deleted.");
}
else
{
    Console.WriteLine("Metadata cleanup failed, most likely due to concurrency issues.");
}
sampleSyncProvider = New SampleSyncProvider()
Dim provider1 As DbSyncProvider = sampleSyncProvider.ConfigureDbSyncProvider(Utility.ConnStr_DbSync1, 7)

If provider1.CleanupMetadata() = True Then
    Console.WriteLine([String].Empty)
    Console.WriteLine("Metadata cleanup ran in the SyncSamplesDb_Peer1 database.")
    Console.WriteLine("Metadata more than 7 days old was deleted.")
Else
    Console.WriteLine("Metadata cleanup failed, most likely due to concurrency issues.")
End If

请参阅

参考

DbSyncProvider类

DbSyncProvider 成员

Microsoft.Synchronization.Data 命名空间