SqlSyncDescriptionBuilder::GetDescriptionForScope Method (String, String, String, SqlConnection)
Returns a DbSyncScopeDescription object that contains information about the specified scope that is defined for a SQL Server database.
Assembly: Microsoft.Synchronization.Data.SqlServer (in Microsoft.Synchronization.Data.SqlServer.dll)
public: static DbSyncScopeDescription^ GetDescriptionForScope( String^ scopeName, String^ objectPrefix, String^ objectSchema, SqlConnection^ connection )
Parameters
- scopeName
- Type: System::String
The name of the scope for which to retrieve a description.
- objectPrefix
- Type: System::String
The optional prefix that is used to identify objects that Sync Framework creates.
- objectSchema
- Type: System::String
The database schema in which Sync Framework creates objects.
- connection
- Type: System.Data.SqlClient::SqlConnection
A SqlConnection object that contains a connection to the database.
Return Value
Type: Microsoft.Synchronization.Data::DbSyncScopeDescriptionA DbSyncScopeDescription object that contains information about the specified scope.
| Exception | Condition |
|---|---|
| ArgumentNullException | connection is nullptr. |
| ArgumentException | scopeName is a nullptr or empty. |
Show: