Share via

AgentProfile.AssignToAgent Method

  • Article

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

public void AssignToAgent (
    string distributionDBName,
    int agentId
)

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

public void AssignToAgent (
    String distributionDBName, 
    int agentId
)

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

Parameters

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

Exceptions

Exception type Condition
ApplicationException

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

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

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

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

AgentProfile Class
AgentProfile Members
Microsoft.SqlServer.Replication Namespace

Other Resources

How to: Work with Replication Agent Profiles (RMO Programming)