Share via

SyncSession.ClientId Property

  • Article

Gets or sets the GUID that Synchronization Services uses to identify the client database.

Namespace: Microsoft.Synchronization.Data
Assembly: Microsoft.Synchronization.Data (in microsoft.synchronization.data.dll)

Syntax

'Declaration
Public Property ClientId As Guid
'Usage
Dim instance As SyncSession
Dim value As Guid

value = instance.ClientId

instance.ClientId = value

public Guid ClientId { get; set; }

public:
property Guid ClientId {
    Guid get ();
    void set (Guid value);
}

/** @property */
public Guid get_ClientId ()

/** @property */
public void set_ClientId (Guid value)

public function get ClientId () : Guid

public function set ClientId (value : Guid)

Property Value

A GUID that identifies the client database.

Remarks

The ID of the client that is currently synchronizing is typically used for conflict detection and to prevent echoing of changes back to the client during bidirectional synchronization. For more information, see How to: Exchange Bidirectional Incremental Data Changes Between a Client and Server.

By default, Sync Framework identifies each client with a GUID, which is returned by the ClientId property. You can also map the GUID to an integer and use the value that is returned by the OriginatorId property. For more information, see How to: Use Session Variables.

See Also

Reference

SyncSession Class
SyncSession Members
Microsoft.Synchronization.Data Namespace