AgentProfile.AssignToAgent 方法

2013-02-02

Assigns the replication agent profile to a specific replication agent job.

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

语法

声明
Public Sub AssignToAgent ( _
    distributionDBName As String, _
    agentId As Integer _
)
用法
Dim instance As AgentProfile 
Dim distributionDBName As String 
Dim agentId As Integer

instance.AssignToAgent(distributionDBName, _
    agentId)

public void AssignToAgent(
    string distributionDBName,
    int agentId
)

public:
void AssignToAgent(
    String^ distributionDBName, 
    int agentId
)

member AssignToAgent : 
        distributionDBName:string * 
        agentId:int -> unit

public function AssignToAgent(
    distributionDBName : String, 
    agentId : int
)

参数

distributionDBName
类型：System.String
A String value that specifies the name of the distribution database used by the replication agent job.

agentId
类型：System.Int32

异常

异常	条件
ApplicationException	When the profile represented by the object does not exist on the server.
ArgumentException	When the value for distributionDBName is nullnull 引用（在 Visual Basic 中为 Nothing）, contains nullnull 引用（在 Visual Basic 中为 Nothing） characters, or is longer than 128-Unicode characters.

注释

A replication agent profile can be assigned to a replication agent job only after it has been created on the database, and it can be assigned only to an agent job for the correct type of replication agent.

Calling AssignToAgent loads profile properties from the server. Call CommitPropertyChanges to commit property changes before calling this method.

The AssignToAgent method can be called only by members of the sysadmin fixed server role at the Distributor.

Calling AssignToAgent is equivalent to executing sp_update_agent_profile (Transact-SQL).