RelationalSyncProvider.BatchingDirectory Property
Gets or sets the directory in which batch files are spooled to disk.
Namespace: Microsoft.Synchronization.Data
Assembly: Microsoft.Synchronization.Data (in Microsoft.Synchronization.Data.dll)
Syntax
'Declaration
Public Property BatchingDirectory As String
Get
Set
'Usage
Dim instance As RelationalSyncProvider
Dim value As String
value = instance.BatchingDirectory
instance.BatchingDirectory = value
public string BatchingDirectory { get; set; }
public:
property String^ BatchingDirectory {
String^ get ();
void set (String^ value);
}
member BatchingDirectory : string with get, set
function get BatchingDirectory () : String
function set BatchingDirectory (value : String)
Property Value
Type: System.String
The directory in which batch files are spooled to disk.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | value is null reference (Nothing in Visual Basic). |
| DbSyncException | A synchronization is already in progress. |
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.
Consider potential side effects when choose a batching directory. For example, when the provider is hosted by Internet Information Services (IIS), do not use an IIS virtual directory as the batching directory. IIS can trigger a restart when changes are made to items in a virtual directory, which causes synchronization to fail.
For more information, see How to: Deliver Changes in Batches (SQL Server).