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)

Syntax

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

returnValue = SqlSyncDescriptionBuilder.GetDescriptionForScope(scopeName, _
    objectPrefix, connection)

public static DbSyncScopeDescription GetDescriptionForScope(
    string scopeName,
    string objectPrefix,
    SqlConnection connection
)

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

static member GetDescriptionForScope : 
        scopeName:string * 
        objectPrefix:string * 
        connection:SqlConnection -> DbSyncScopeDescription 

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

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.

Exceptions

See Also

Reference

SqlSyncDescriptionBuilder Class

GetDescriptionForScope Overload

Microsoft.Synchronization.Data.SqlServer Namespace