Méthode AgentProfile.AssignToAgent

  • Article

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

Espace de noms :  Microsoft.SqlServer.Replication
Assembly :  Microsoft.SqlServer.Rmo (en Microsoft.SqlServer.Rmo.dll)

Syntaxe

'Déclaration
Public Sub AssignToAgent ( _
    distributionDBName As String, _
    agentId As Integer _
)
'Utilisation
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
)

Paramètres

  • 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 nullune référence Null (Nothing dans Visual Basic), contains nullune référence Null (Nothing dans Visual Basic) characters, or is longer than 128-Unicode characters.

Notes

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

Voir aussi

Référence

AgentProfile Classe

Espace de noms Microsoft.SqlServer.Replication

Autres ressources

Utiliser des profils d'agent de réplication (programmation RMO)