SyncSession.ClientId Property

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

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

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

Syntax

'Declaration
Public Property ClientId As Guid

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 Services for ADO.NET 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.

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.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements (Sync Framework).

Target Platforms

See Also

Reference

SyncSession Class
SyncSession Members
Microsoft.Synchronization.Data.Common Namespace