SqlSyncDescriptionBuilder.GetDescriptionForScope Method (String, 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, _
    objectSchema As String, _
    connection As SqlConnection _
) As DbSyncScopeDescription
'Usage
Dim scopeName As String
Dim objectPrefix As String
Dim objectSchema As String
Dim connection As SqlConnection
Dim returnValue As DbSyncScopeDescription

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

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

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

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

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

Parameters

• scopeName
  The name of the scope for which to retrieve a description.

• objectPrefix
  The optional prefix that is used to identify objects that Sync Framework creates.

• objectSchema
  The database schema in which Sync Framework creates objects.

• connection
  A SqlConnection object that contains a connection to the database.

Return Value

A DbSyncScopeDescription object that contains information about the specified scope.

See Also

Reference

SqlSyncDescriptionBuilder Class
SqlSyncDescriptionBuilder Members
Microsoft.Synchronization.Data.SqlServer Namespace