• Article

AgentProfile.AssignToAgent Method

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

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)

Syntax

'Declaration
Public Sub AssignToAgent ( _
    distributionDBName As String, _
    agentId As Integer _
)
'Usage
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
)

Parameters

  • distributionDBName
    Type: System.String
    A String value that specifies the name of the distribution database used by the replication agent job.

Exceptions

Exception Condition
ApplicationException

When the profile represented by the object does not exist on the server.
ArgumentException

When the value for distributionDBName is nulla null reference (Nothing in Visual Basic), contains nulla null reference (Nothing in Visual Basic) characters, or is longer than 128-Unicode characters.

Remarks

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

This namespace, class, or member is supported only in the .NET Framework 2.0.