DbSyncProvider.CleanupMetadata Method

Removes change tracking data from the peer database.

This method is not CLS-compliant.  

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

Syntax

'Declaration
<SuppressMessageAttribute("Microsoft.Globalization", "CA1303:DoNotPassLiteralsAsLocalizedParameters")> _
Public Function CleanupMetadata As Boolean
'Usage
Dim instance As DbSyncProvider
Dim returnValue As Boolean

returnValue = instance.CleanupMetadata

[SuppressMessageAttribute("Microsoft.Globalization", "CA1303:DoNotPassLiteralsAsLocalizedParameters")] 
public bool CleanupMetadata ()

[SuppressMessageAttribute(L"Microsoft.Globalization", L"CA1303:DoNotPassLiteralsAsLocalizedParameters")] 
public:
bool CleanupMetadata ()

/** @attribute SuppressMessageAttribute("Microsoft.Globalization", "CA1303:DoNotPassLiteralsAsLocalizedParameters") */ 
public boolean CleanupMetadata ()

SuppressMessageAttribute("Microsoft.Globalization", "CA1303:DoNotPassLiteralsAsLocalizedParameters") 
public function CleanupMetadata () : boolean

Return Value

true if metadata cleanup ran successfully; otherwise false.

Remarks

Cleanup involves deleting metadata for rows that have been deleted from a base table. There are two components to metadata cleanup:

• The command that you specify for the SelectMetadataForCleanupCommand property for each table's DbSyncAdapter object.

• The CleanupMetadata method that you call from an application.

For more information, including a complete code example, see How to: Clean Up Metadata for Peer-to-Peer Synchronization.

See Also

Reference

DbSyncProvider Class
DbSyncProvider Members
Microsoft.Synchronization.Data Namespace