.AssignToAgent Method (String, Int32)
Applies To: SQL Server 2016 Preview
Assigns the replication agent profile to a specific replication agent job.
Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)
public void AssignToAgent(
String value that specifies the name of the distribution database used by the replication agent job. agentID
Int32 value that specifies the replication agent job.
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.
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.
AssignToAgent loads profile properties from the server. Call CommitPropertyChanges to commit property changes before calling this method.
AssignToAgent method can be called only by members of the sysadmin fixed server role at the Distributor.
AssignToAgent is equivalent to executing sp_update_agent_profile (Transact-SQL). Return to top