Share via

SqlCeSyncDescriptionBuilder.GetDescriptionForScope Method (String, )

  • Article

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)

Syntax

'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)

public static DbSyncScopeDescription GetDescriptionForScope(
    string scopeName,
    SqlCeConnection connection
)

public:
static DbSyncScopeDescription^ GetDescriptionForScope(
    String^ scopeName, 
    SqlCeConnection^ connection
)

static member GetDescriptionForScope : 
        scopeName:string * 
        connection:SqlCeConnection -> DbSyncScopeDescription 

public static function GetDescriptionForScope(
    scopeName : String, 
    connection : SqlCeConnection
) : DbSyncScopeDescription

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.

Exceptions

Exception Condition
ArgumentNullException

connection is a null reference (Nothing in Visual Basic).
ArgumentException

scopeName is a null reference (Nothing in Visual Basic) or empty.

See Also

Reference

SqlCeSyncDescriptionBuilder Class

GetDescriptionForScope Overload

Microsoft.Synchronization.Data.SqlServerCe Namespace