SqlSyncDescriptionBuilder::GetDescriptionForScope Method (String, String, SqlConnection)

Returns a DbSyncScopeDescription object that contains information about the specified scope that is defined for a SQL Server database.

Namespace:  Microsoft.Synchronization.Data.SqlServer
Assembly:  Microsoft.Synchronization.Data.SqlServer (in Microsoft.Synchronization.Data.SqlServer.dll)

public:
static DbSyncScopeDescription^ GetDescriptionForScope(
	String^ scopeName, 
	String^ objectPrefix, 
	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.
connection
Type: System.Data.SqlClient::SqlConnection
A SqlConnection object that contains a connection to the database.

Return Value

Type: Microsoft.Synchronization.Data::DbSyncScopeDescription
A DbSyncScopeDescription object that contains information about the specified scope.

ExceptionCondition
ArgumentNullException

connection is nullptr.

ArgumentException

scopeName is a nullptr or empty.

Show: