Compartir a través de

AgentProfile.AssignToAgent Method

  • Artículo

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

Espacio de nombres: Microsoft.SqlServer.Replication
Ensamblado: Microsoft.SqlServer.Rmo (in microsoft.sqlserver.rmo.dll)

Sintaxis

'Declaración
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
)

Parámetros

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

Excepciones

Tipo de excepción Condición
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.

Notas

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.

Seguridad para subprocesos

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.

Plataformas

Plataformas de desarrollo

Para obtener una lista de las plataformas compatibles, vea Requisitos de hardware y software para instalar SQL Server 2005.

Plataformas de destino

Para obtener una lista de las plataformas compatibles, vea Requisitos de hardware y software para instalar SQL Server 2005.

Vea también

Referencia

AgentProfile Class
AgentProfile Members
Microsoft.SqlServer.Replication Namespace

Otros recursos

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