DbSyncSession Class
Represents a synchronization session. The DbSyncSession object exists for the duration of the synchronization session.
Inheritance Hierarchy
System.Object
Microsoft.Synchronization.Data.DbSyncSession
Namespace: Microsoft.Synchronization.Data
Assembly: Microsoft.Synchronization.Data (in Microsoft.Synchronization.Data.dll)
Syntax
'Declaration
<SerializableAttribute> _
Public Class DbSyncSession
'Usage
Dim instance As DbSyncSession
[SerializableAttribute]
public class DbSyncSession
[SerializableAttribute]
public ref class DbSyncSession
[<SerializableAttribute>]
type DbSyncSession = class end
public class DbSyncSession
The DbSyncSession type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() |
DbSyncSession | Initializes a new instance of the DbSyncSession class. |
Top
Properties
Name | Description | |
---|---|---|
![]() |
SessionId | Gets the GUID that Sync Framework uses to identify the synchronization session. |
![]() |
SyncParameters | Gets or sets a SyncParameterCollection of SyncParameter objects. These objects are available at the peer as session variables. |
Top
Methods
Name | Description | |
---|---|---|
![]() |
Equals | (Inherited from Object.) |
![]() |
Finalize | (Inherited from Object.) |
![]() |
GetHashCode | (Inherited from Object.) |
![]() |
GetType | (Inherited from Object.) |
![]() |
MemberwiseClone | (Inherited from Object.) |
![]() |
ToString | (Inherited from Object.) |
Top
Fields
Name | Description | |
---|---|---|
![]() ![]() |
SyncCheckConcurrency | Returns the string sync_check_concurrency. This field is constant. |
![]() ![]() |
SyncCreatePeerKey | Returns the string sync_create_peer_key. This field is constant. |
![]() ![]() |
SyncCreatePeerTimestamp | Returns the string sync_create_peer_timestamp. This field is constant. |
![]() ![]() |
SyncForceWrite | Returns the string sync_force_write. This field is constant. |
![]() ![]() |
SyncInitialize | Returns the string sync_initialize. This field is constant. |
![]() ![]() |
SyncMetadataOnly | Returns the string sync_metadata_only. This field is constant. |
![]() ![]() |
SyncMinTimestamp | Returns the string sync_min_timestamp. This field is constant. |
![]() ![]() |
SyncNewTimestamp | Returns the string sync_new_timestamp. This field is constant. |
![]() ![]() |
SyncRowCount | Returns the string sync_row_count. This field is constant. |
![]() ![]() |
SyncRowCreateTimestamp | Returns the string sync_row_create_timestamp. This field is constant. |
![]() ![]() |
SyncRowIsTombstone | Returns the string sync_row_is_tombstone. This field is constant. |
![]() ![]() |
SyncRowTimestamp | Returns the string sync_row_timestamp. This field is constant. |
![]() ![]() |
SyncScopeCleanupKnowledge | Returns the string sync_scope_cleanup_knowledge. This field is constant. |
![]() ![]() |
SyncScopeCleanupTimestamp | Returns the string sync_scope_cleanup_timestamp. This field is constant. |
![]() ![]() |
SyncScopeId | Returns the string sync_scope_id. This field is constant. |
![]() ![]() |
SyncScopeKnowledge | Returns the string sync_scope_knowledge. This field is constant. |
![]() ![]() |
SyncScopeLocalId | Returns the string sync_scope_local_id. This field is constant. |
![]() ![]() |
SyncScopeName | Returns the string sync_scope_name. This field is constant. |
![]() ![]() |
SyncScopeRestoreCount | Returns the string sync_scope_restore_count. This field is constant. |
![]() ![]() |
SyncScopeTimestamp | Returns the string sync_scope_timestamp. This field is constant. |
![]() ![]() |
SyncSessionId | Returns the string sync_session_id. This field is constant. |
![]() ![]() |
SyncSharedScopeName | Returns the string sync_shared_scope_name. This field is constant. |
![]() ![]() |
SyncStageName | Returns the string sync_stage_name. This field is constant. |
![]() ![]() |
SyncTableName | Returns the string sync_table_name. This field is constant. |
![]() ![]() |
SyncUpdatePeerKey | Returns the string sync_update_peer_key. This field is constant. |
![]() ![]() |
SyncUpdatePeerTimestamp | Returns the string sync_update_peer_timestamp. This field is constant. |
Top
Remarks
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).
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.