DbSyncSession Class

Represents a synchronization session. The DbSyncSession object exists for the duration of the synchronization session.

System.Object
  Microsoft.Synchronization.Data.DbSyncSession

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

[SerializableAttribute]
public class DbSyncSession

The DbSyncSession type exposes the following members.

  NameDescription
Public methodDbSyncSessionInitializes a new instance of the DbSyncSession class.
Top

  NameDescription
Public propertySessionIdGets the GUID that Sync Framework uses to identify the synchronization session.
Public propertySyncParametersGets or sets a SyncParameterCollection of SyncParameter objects. These objects are available at the peer as session variables.
Top

  NameDescription
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString (Inherited from Object.)
Top

  NameDescription
Public fieldStatic memberSyncCheckConcurrencyReturns the string sync_check_concurrency. This field is constant.
Public fieldStatic memberSyncCreatePeerKeyReturns the string sync_create_peer_key. This field is constant.
Public fieldStatic memberSyncCreatePeerTimestampReturns the string sync_create_peer_timestamp. This field is constant.
Public fieldStatic memberSyncForceWriteReturns the string sync_force_write. This field is constant.
Public fieldStatic memberSyncInitializeReturns the string sync_initialize. This field is constant.
Public fieldStatic memberSyncMetadataOnlyReturns the string sync_metadata_only. This field is constant.
Public fieldStatic memberSyncMinTimestampReturns the string sync_min_timestamp. This field is constant.
Public fieldStatic memberSyncNewTimestampReturns the string sync_new_timestamp. This field is constant.
Public fieldStatic memberSyncRowCountReturns the string sync_row_count. This field is constant.
Public fieldStatic memberSyncRowCreateTimestampReturns the string sync_row_create_timestamp. This field is constant.
Public fieldStatic memberSyncRowIsTombstoneReturns the string sync_row_is_tombstone. This field is constant.
Public fieldStatic memberSyncRowTimestampReturns the string sync_row_timestamp. This field is constant.
Public fieldStatic memberSyncScopeCleanupKnowledgeReturns the string sync_scope_cleanup_knowledge. This field is constant.
Public fieldStatic memberSyncScopeCleanupTimestampReturns the string sync_scope_cleanup_timestamp. This field is constant.
Public fieldStatic memberSyncScopeIdReturns the string sync_scope_id. This field is constant.
Public fieldStatic memberSyncScopeKnowledgeReturns the string sync_scope_knowledge. This field is constant.
Public fieldStatic memberSyncScopeLocalIdReturns the string sync_scope_local_id. This field is constant.
Public fieldStatic memberSyncScopeNameReturns the string sync_scope_name. This field is constant.
Public fieldStatic memberSyncScopeRestoreCountReturns the string sync_scope_restore_count. This field is constant.
Public fieldStatic memberSyncScopeTimestampReturns the string sync_scope_timestamp. This field is constant.
Public fieldStatic memberSyncSessionIdReturns the string sync_session_id. This field is constant.
Public fieldStatic memberSyncSharedScopeNameReturns the string sync_shared_scope_name. This field is constant.
Public fieldStatic memberSyncStageNameReturns the string sync_stage_name. This field is constant.
Public fieldStatic memberSyncTableNameReturns the string sync_table_name. This field is constant.
Public fieldStatic memberSyncUpdatePeerKeyReturns the string sync_update_peer_key. This field is constant.
Public fieldStatic memberSyncUpdatePeerTimestampReturns the string sync_update_peer_timestamp. This field is constant.
Top

The DbSyncSession object is sent to the peer in every call and provides a way to transfer built-in session variables. For more information about session variables, see How to: Use Session Variables for Collaborative Synchronization (Non-SQL Server).

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