AgentProfile.AgentType Property

Gets or sets the type of replication agent for which the profile is intended.

Namespace: Microsoft.SqlServer.Replication
Assembly: Microsoft.SqlServer.Rmo (in microsoft.sqlserver.rmo.dll)

Syntax

'Declaration
Public Property AgentType As AgentType

public AgentType AgentType { get; set; }

public:
property AgentType AgentType {
    AgentType get ();
    void set (AgentType value);
}

/** @property */
public AgentType get_AgentType ()

/** @property */
public void set_AgentType (AgentType value)

public function get AgentType () : AgentType

public function set AgentType (value : AgentType)

Property Value

An AgentType object value that specifies the replication agent type.

Exceptions

Exception type	Condition
ApplicationException	When you set AgentType for an existing profile. When MiscellaneousAgents or any other unsupported values of AgentType are supplied.

Remarks

The AgentType property is a read/write property, and it is necessary to set this property before the object is created. Once the profile has been created on the server, this property cannot be changed.

Setting a value of MiscellaneousAgents is not supported.

The AgentType property can be retrieved only by members of the sysadmin fixed server role at the Distributor or by members of the replmonitor fixed database role.

The AgentType property can be set only by members of the sysadmin fixed server role at the Distributor when a new profile is being created on the server.

Retrieving AgentType is equivalent to executing sp_help_agent_profile (Transact-SQL).

Setting AgentType and calling Create is equivalent to executing sp_add_agent_profile (Transact-SQL).

The AgentType property is available with SQL Server 2005, SQL Server 2000, and SQL Server 7.0.

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)
Replication Agents Overview