ScopeName プロパティ
同期するスコープの名前を取得または設定します。
名前空間: Microsoft.Synchronization.Data
アセンブリ: Microsoft.Synchronization.Data (Microsoft.Synchronization.Data.dll 内)
構文
'宣言
Public Overridable Property ScopeName As String
Get
Set
'使用
Dim instance As RelationalSyncProvider
Dim value As String
value = instance.ScopeName
instance.ScopeName = value
public virtual string ScopeName { get; set; }
public:
virtual property String^ ScopeName {
String^ get ();
void set (String^ value);
}
abstract ScopeName : string with get, set
override ScopeName : string with get, set
function get ScopeName () : String
function set ScopeName (value : String)
プロパティ値
型 : System. . :: . .String
スコープ、つまり同期する一連のオブジェクトの名前。
例外
| 例外 | 条件 |
|---|---|
| ObjectDisposedException | この RelationalSyncProvider は破棄されています。 |
| ArgumentNullException | value が null Nothing nullptr unit NULL 参照 (Visual Basic では Nothing) です。 |
説明
データベース同期では、スコープは一連のテーブルになります。スコープの使用方法の詳細については、「コラボレーション同期用にサーバー データベースを準備する方法 (SQL Server 以外)」および「方法: データベース同期を構成して実行する (SQL Server)」を参照してください。
例
次のコード例では、このドキュメント用に作成された SetupSyncProvider メソッドで DbSyncProvider オブジェクトのスコープを指定します。このメソッドを使用すると、プロバイダーを複数のノード用に簡単に構成できます。完全なコンテキスト例でこのコードを表示するには、「コラボレーション同期を構成して実行する方法 (SQL Server 以外)」を参照してください。
SqlConnection peerConnection = new SqlConnection(peerConnString);
sampleProvider.Connection = peerConnection;
sampleProvider.ScopeName = "Sales";
Dim peerConnection As New SqlConnection(peerConnString)
sampleProvider.Connection = peerConnection
sampleProvider.ScopeName = "Sales"
次のコード例では、SqlSyncProvider オブジェクトのスコープを指定する際、ScopeName を直接設定する代わりに DbSyncScopeDescription オブジェクトを使用します。完全なコンテキスト例でこのコードを表示するには、「方法: データベース同期を構成して実行する (SQL Server)」を参照してください。
DbSyncScopeDescription scopeDesc = new DbSyncScopeDescription("filtered_customer");
// Definition for Customer.
DbSyncTableDescription customerDescription =
SqlSyncDescriptionBuilder.GetDescriptionForTable("Sales.Customer", serverConn);
scopeDesc.Tables.Add(customerDescription);
// Definition for CustomerContact, including the list of columns to include.
Collection<string> columnsToInclude = new Collection<string>();
columnsToInclude.Add("CustomerId");
columnsToInclude.Add("PhoneType");
DbSyncTableDescription customerContactDescription =
SqlSyncDescriptionBuilder.GetDescriptionForTable("Sales.CustomerContact", columnsToInclude, serverConn);
scopeDesc.Tables.Add(customerContactDescription);
Dim scopeDesc As New DbSyncScopeDescription("filtered_customer")
' Definition for Customer.
Dim customerDescription As DbSyncTableDescription = _
SqlSyncDescriptionBuilder.GetDescriptionForTable("Sales.Customer", serverConn)
scopeDesc.Tables.Add(customerDescription)
' Definition for CustomerContact, including the list of columns to include.
Dim columnsToInclude As New Collection(Of String)()
columnsToInclude.Add("CustomerId")
columnsToInclude.Add("PhoneType")
Dim customerContactDescription As DbSyncTableDescription = _
SqlSyncDescriptionBuilder.GetDescriptionForTable("Sales.CustomerContact", columnsToInclude, serverConn)
scopeDesc.Tables.Add(customerContactDescription)