DbSyncProvider.ScopeIdColName Property
Gets or sets the name the column in the scope information table that contains an identifier for the scope, typically a GUID.
Namespace: Microsoft.Synchronization.Data
Assembly: Microsoft.Synchronization.Data (in Microsoft.Synchronization.Data.dll)
Syntax
'Declaration
Protected Property ScopeIdColName As String
Get
Set
'Usage
Dim value As String
value = Me.ScopeIdColName
Me.ScopeIdColName = value
protected string ScopeIdColName { get; set; }
protected:
property String^ ScopeIdColName {
String^ get ();
void set (String^ value);
}
member ScopeIdColName : string with get, set
function get ScopeIdColName () : String
function set ScopeIdColName (value : String)
Property Value
Type: System.String
The name of the column, with a default of scope_id.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | value is a null reference (Nothing in Visual Basic). |
| ObjectDisposedException | This DbSyncProvider is disposed. |
Remarks
The name of the column must match the name that is used in synchronization queries or stored procedures. The name of this column is typically changed only if the default name is not a valid identifier in the database that is provisioned for synchronization. For more information about metadata columns, see How to: Provision a Server Database for Collaborative Synchronization (Non-SQL Server).