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
Get
Set
'Usage
Dim instance As AgentProfile
Dim value As AgentType
value = instance.AgentType
instance.AgentType = value
public AgentType AgentType { get; set; }
public:
property AgentType AgentType {
AgentType get ();
void set (AgentType value);
}
member AgentType : AgentType with get, set
function get AgentType () : AgentType
function set AgentType (value : AgentType)
Property Value
Type: Microsoft.SqlServer.Replication.AgentType
An AgentType object value that specifies the replication agent type.
Exceptions
| Exception | 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.