GetDescriptionForScope 方法 (String, String, String, SqlConnection)

返回一个 DbSyncScopeDescription 对象，该对象包含有关为 SQL Server 数据库定义的指定作用域的信息。

命名空间：  Microsoft.Synchronization.Data.SqlServer
程序集：  Microsoft.Synchronization.Data.SqlServer（在 Microsoft.Synchronization.Data.SqlServer.dll 中）

语法

声明
Public Shared Function GetDescriptionForScope ( _
    scopeName As String, _
    objectPrefix As String, _
    objectSchema As String, _
    connection As SqlConnection _
) As DbSyncScopeDescription
用法
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
)

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

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

参数

• scopeName
  类型：System. . :: . .String
  要为其检索说明的作用域的名称。

• objectPrefix
  类型：System. . :: . .String
  用于标识 Sync Framework 创建的对象的可选前缀。

• objectSchema
  类型：System. . :: . .String
  Sync Framework 创建对象所采用的数据库架构。

• connection
  类型：System.Data.SqlClient. . :: . .SqlConnection
  包含与数据库的连接的 SqlConnection 对象。

返回值

类型：Microsoft.Synchronization.Data. . :: . .DbSyncScopeDescription
一个包含指定作用域相关信息的 DbSyncScopeDescription 对象。

异常

异常	条件
ArgumentNullException	connection 为 null Nothing nullptr unit null 引用（在 Visual Basic 中为 Nothing） 。
ArgumentException	scopeName 为 null Nothing nullptr unit null 引用（在 Visual Basic 中为 Nothing） 或空。

请参阅

参考

SqlSyncDescriptionBuilder类

SqlSyncDescriptionBuilder 成员

GetDescriptionForScope 重载

Microsoft.Synchronization.Data.SqlServer 命名空间