SqlCeSyncDescriptionBuilder.GetDescriptionForScope Method (String, )

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

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

'Declaration
Public Shared Function GetDescriptionForScope ( _
	scopeName As String, _
	connection As SqlCeConnection _
) As DbSyncScopeDescription
'Usage
Dim scopeName As String
Dim connection As SqlCeConnection
Dim returnValue As DbSyncScopeDescription

returnValue = SqlCeSyncDescriptionBuilder.GetDescriptionForScope(scopeName, _
	connection)

Parameters

scopeName
Type: System.String
The name of the scope for which to retrieve a description.
connection
Type: SqlCeConnection
A SqlCeConnection 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 a Nothing.

ArgumentException

scopeName is a Nothing or empty.

Show: