Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

SyncSession Class

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

System.Object
  Microsoft.Synchronization.Data.SyncSession

Namespace:  Microsoft.Synchronization.Data
Assembly:  Microsoft.Synchronization.Data (in Microsoft.Synchronization.Data.dll)
[SerializableAttribute]
public class SyncSession

The SyncSession type exposes the following members.

  NameDescription
Public methodSyncSessionInitializes a new instance of the SyncSession class.
Top
  NameDescription
Public propertyClientIdGets or sets the GUID that Synchronization Services uses to identify the client database.
Public propertyOriginatorIdGets or sets the originator ID. This enables you to map the ClientId to a different value on the server.
Public propertySessionIdGets the GUID that Synchronization Services uses to identify the synchronization session.
Public propertySyncParametersGets or sets a SyncParameterCollection of SyncParameter objects. These objects are available at the server 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 memberSyncBatchCountReturns the string sync_batch_count. This field is constant.
Public fieldStatic memberSyncBatchSizeReturns the string sync_batch_size. This field is constant.
Public fieldStatic memberSyncClientIdReturns the string sync_client_id. This field is constant.
Public fieldStatic memberSyncClientIdBinaryReturns the string sync_client_id_binary. This field is constant.
Public fieldStatic memberSyncClientIdHashReturns the string sync_client_id_hash. This field is constant.
Public fieldStatic memberSyncForceWriteReturns the string sync_force_write. This field is constant.
Public fieldStatic memberSyncGroupNameReturns the string sync_group_name. This field is constant.
Public fieldStatic memberSyncInitializedReturns the string sync_initialized. This field is constant.
Public fieldStatic memberSyncLastReceivedAnchorReturns the string sync_last_received_anchor. This field is constant.
Public fieldStatic memberSyncMaxReceivedAnchorReturns the string sync_max_received_anchor. This field is constant.
Public fieldStatic memberSyncNewReceivedAnchorReturns the string sync_new_received_anchor. This field is constant.
Public fieldStatic memberSyncOriginatorIdReturns the string sync_originator_id. This field is constant.
Public fieldStatic memberSyncRowCountReturns the string sync_row_count. This field is constant.
Public fieldStatic memberSyncSessionIdReturns the string sync_session_id. This field is constant.
Public fieldStatic memberSyncTableNameReturns the string sync_table_name. This field is constant.
Top

The SyncSession object is sent to the server in every call and provides a way to transfer built-in session variables. For more information, see How to: Use Session Variables.

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:
© 2014 Microsoft. All rights reserved.