DbSyncSession.SyncParameters Property

Gets or sets a SyncParameterCollection of SyncParameter objects. These objects are available at the peer as session variables.

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

Syntax

'Declaration
<SuppressMessageAttribute("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")> _
<XmlElementAttribute("CustomParameters")> _
Public Property SyncParameters As SyncParameterCollection
'Usage
Dim instance As DbSyncSession
Dim value As SyncParameterCollection

value = instance.SyncParameters

instance.SyncParameters = value

[SuppressMessageAttribute("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")] 
[XmlElementAttribute("CustomParameters")] 
public SyncParameterCollection SyncParameters { get; set; }

[SuppressMessageAttribute(L"Microsoft.Usage", L"CA2227:CollectionPropertiesShouldBeReadOnly")] 
[XmlElementAttribute(L"CustomParameters")] 
public:
property SyncParameterCollection^ SyncParameters {
    SyncParameterCollection^ get ();
    void set (SyncParameterCollection^ value);
}

/** @property */
public SyncParameterCollection get_SyncParameters ()

/** @property */
public void set_SyncParameters (SyncParameterCollection value)

public function get SyncParameters () : SyncParameterCollection

public function set SyncParameters (value : SyncParameterCollection)

Property Value

A SyncParameterCollection of SyncParameter objects.

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).

See Also

Reference

DbSyncSession Class
DbSyncSession Members
Microsoft.Synchronization.Data Namespace