SyncSession Class

Article
10/22/2010

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

Inheritance Hierarchy

System.Object
Microsoft.Synchronization.Data.SyncSession

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

Syntax

'Declaration
<SerializableAttribute> _
Public Class SyncSession
'Usage
Dim instance As SyncSession

[SerializableAttribute]
public class SyncSession

[SerializableAttribute]
public ref class SyncSession

[<SerializableAttribute>]
type SyncSession =  class end

public class SyncSession

The SyncSession type exposes the following members.

Constructors

	Name	Description
	SyncSession	Initializes a new instance of the SyncSession class.

Top

Properties

	Name	Description
	ClientId	Gets or sets the GUID that Synchronization Services uses to identify the client database.
	OriginatorId	Gets or sets the originator ID. This enables you to map the ClientId to a different value on the server.
	SessionId	Gets the GUID that Synchronization Services uses to identify the synchronization session.
	SyncParameters	Gets or sets a SyncParameterCollection of SyncParameter objects. These objects are available at the server 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
	SyncBatchCount	Returns the string sync_batch_count. This field is constant.
	SyncBatchSize	Returns the string sync_batch_size. This field is constant.
	SyncClientId	Returns the string sync_client_id. This field is constant.
	SyncClientIdBinary	Returns the string sync_client_id_binary. This field is constant.
	SyncClientIdHash	Returns the string sync_client_id_hash. This field is constant.
	SyncForceWrite	Returns the string sync_force_write. This field is constant.
	SyncGroupName	Returns the string sync_group_name. This field is constant.
	SyncInitialized	Returns the string sync_initialized. This field is constant.
	SyncLastReceivedAnchor	Returns the string sync_last_received_anchor. This field is constant.
	SyncMaxReceivedAnchor	Returns the string sync_max_received_anchor. This field is constant.
	SyncNewReceivedAnchor	Returns the string sync_new_received_anchor. This field is constant.
	SyncOriginatorId	Returns the string sync_originator_id. This field is constant.
	SyncRowCount	Returns the string sync_row_count. This field is constant.
	SyncSessionId	Returns the string sync_session_id. This field is constant.
	SyncTableName	Returns the string sync_table_name. This field is constant.

Top

Remarks

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.

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.

Share via