AgentProfile.AssignToAgent(String, Int32) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Assigns the replication agent profile to a specific replication agent job.
public:
void AssignToAgent(System::String ^ distributionDBName, int agentId);public void AssignToAgent (string distributionDBName, int agentId);member this.AssignToAgent : string * int -> unitPublic Sub AssignToAgent (distributionDBName As String, agentId As Integer)Parameters
- distributionDBName
- String
The name of the distribution database used by the replication agent job.
- agentId
- Int32
The replication agent job.
Exceptions
When the profile represented by the object does not exist on the server.
When the value for distributionDBName is null, contains null 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).