Share via

RelationalSyncProvider.CleanupBatchingDirectory Property

  • Article

Gets or sets whether to clean up batching files after the changes in the files have been applied to the destination.

This property is not CLS-compliant.  

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

Syntax

'Declaration
Public Property CleanupBatchingDirectory As Boolean
'Usage
Dim instance As RelationalSyncProvider
Dim value As Boolean

value = instance.CleanupBatchingDirectory

instance.CleanupBatchingDirectory = value

public bool CleanupBatchingDirectory { get; set; }

public:
property bool CleanupBatchingDirectory {
    bool get ();
    void set (bool value);
}

/** @property */
public boolean get_CleanupBatchingDirectory ()

/** @property */
public void set_CleanupBatchingDirectory (boolean value)

public function get CleanupBatchingDirectory () : boolean

public function set CleanupBatchingDirectory (value : boolean)

Property Value

true if batching files are cleaned up after the changes in the files have been applied to the destination (the default); otherwise false.

Remarks

This property is used when an application requires that changes be delivered in batches. Batching is useful in scenarios similar to the following one:

  • A large number of clients that use SqlCeSyncProvider synchronize periodically with a server that uses SqlSyncProvider.

  • Each client has a limited amount of memory and disk space.

  • The connections between the server and clients are low bandwidth and intermittent, often resulting in long synchronization times and dropped connections.

  • The size of the changes (in KB) for a typical synchronization session is large.

For more information, see How to: Deliver Changes in Batches (SQL Server).

See Also

Reference

RelationalSyncProvider Class
RelationalSyncProvider Members
Microsoft.Synchronization.Data Namespace