SqlSyncDescriptionBuilder.GetDescriptionForScope Method (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)
Syntax
'Declaration
Public Shared Function GetDescriptionForScope ( _
scopeName As String, _
connection As SqlConnection _
) As DbSyncScopeDescription
'Usage
Dim scopeName As String
Dim connection As SqlConnection
Dim returnValue As DbSyncScopeDescription
returnValue = SqlSyncDescriptionBuilder.GetDescriptionForScope(scopeName, _
connection)
public static DbSyncScopeDescription GetDescriptionForScope(
string scopeName,
SqlConnection connection
)
public:
static DbSyncScopeDescription^ GetDescriptionForScope(
String^ scopeName,
SqlConnection^ connection
)
static member GetDescriptionForScope :
scopeName:string *
connection:SqlConnection -> DbSyncScopeDescription
public static function GetDescriptionForScope(
scopeName : String,
connection : SqlConnection
) : DbSyncScopeDescription
Parameters
- scopeName
Type: System.String
The name of the scope for which to retrieve a description.
- 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.
Exceptions
Exception | Condition |
---|---|
ArgumentNullException | connection is null reference (Nothing in Visual Basic). |
ArgumentException | scopeName is a null reference (Nothing in Visual Basic) or empty. |
See Also
Reference
SqlSyncDescriptionBuilder Class