Share via

  • Artikel

UpdateAgentProfile Method

Diese Funktion wird in zukünftigen Versionen von Microsoft SQL Server nicht mehr bereitgestellt. Verwenden Sie diese Funktion beim Entwickeln neuer Anwendungen nicht, und planen Sie das Ändern von Anwendungen, in denen es zurzeit verwendet wird.

The UpdateAgentProfile method alters a profile setting for the agent specified.

Syntax

object.UpdateAgentProfile(DistributionDB,AgentType,AgentID,ConfigurationID)

Parts

  • object
    Expression that evaluates to an object in the Applies To list.

  • DistributionDB
    String.

  • AgentType
    Long integer that specifies a replication agent type as described in Settings.

  • AgentID
    Long integer.

  • ConfigurationID
    Long integer.

Prototype (C/C++)

HRESULT UpdateAgentProfile(
SQLDMO_LPCSTR DistributionDBName,
SQLDMO_REPLAGENT_TYPE AgentType,
long lAgentID,
long lConfigurationID);

Settings

Set the AgentType argument by using these SQLDMO_REPLAGENT_TYPE values.

Constant

Value

Description

SQLDMOReplAgent_Distribution

3

Replication Distribution Agent.

SQLDMOReplAgent_LogReader

2

Replication transaction log monitoring agent.

SQLDMOReplAgent_Merge

4

Replication Merge Agent.

SQLDMOReplAgent_/QueueReader

9

Replication Queue Reader Agent.

SQLDMOReplAgent_Snapshot

1

Replication Snapshot Agent.

Hinweise

Changing a replication agent profile setting by using the UpdateAgentProfilemethod requires appropriate permission. The SQL Server login used for SQLServer object connection must be a member of the fixed role sysadmin.

Applies To:

Distributor Object