DbSyncBatchInfo Class

Represents a batch header file that contains metadata about the data contained in a synchronization batch.

This API is not CLS-compliant. 

Inheritance Hierarchy

System.Object
  Microsoft.Synchronization.Data.DbSyncBatchInfo

Namespace:  Microsoft.Synchronization.Data
Assembly:  Microsoft.Synchronization.Data (in Microsoft.Synchronization.Data.dll)

Syntax

'Declaration
<SerializableAttribute> _
<CLSCompliantAttribute(False)> _
Public Class DbSyncBatchInfo _
    Implements IDisposable
'Usage
Dim instance As DbSyncBatchInfo
[SerializableAttribute]
[CLSCompliantAttribute(false)]
public class DbSyncBatchInfo : IDisposable
[SerializableAttribute]
[CLSCompliantAttribute(false)]
public ref class DbSyncBatchInfo : IDisposable
[<SerializableAttribute>]
[<CLSCompliantAttribute(false)>]
type DbSyncBatchInfo =  
    class
        interface IDisposable
    end
public class DbSyncBatchInfo implements IDisposable

The DbSyncBatchInfo type exposes the following members.

Constructors

  Name Description
Public method DbSyncBatchInfo Initializes a new instance of the DbSyncBatchInfo class.

Top

Properties

  Name Description
Public property DataCacheSize Gets or sets the in-memory size of the current batch.
Public property DataSetSurrogate Gets or sets a DataSetSurrogate object, which contains the in-memory data set that represents the batch.
Public property Id Gets or sets an ID that uniquely identifies the batch.
Public property IsLastBatch Gets or sets whether the current batch is the last batch of the synchronization session.
Public property SequenceNumber Gets or sets the sequence number of the batch at the source provider so that the destination provider processes batches in the correct order.
Public property Version Represents the version of Sync Framework that generated the batch file.

Top

Methods

  Name Description
Public method Dispose() Releases all resources used by the DbSyncBatchInfo.
Protected method Dispose(Boolean) Releases the unmanaged resources used by the DbSyncBatchInfo and optionally releases the managed resources.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetLearnedKnowledge Gets the synchronization knowledge that is learned by the destination after it applies this batch.
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method SetLearnedKnowledge Sets the synchronization knowledge that is learned by the destination after it applies this batch.
Public method ToString Returns a string that represents the DbSyncBatchInfo object. (Overrides Object.ToString().)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.Synchronization.Data Namespace