Subscription.AgentOffload Property
Gets or sets whether the synchronization agent runs on a computer other than the one where the agent job was created. This property is no longer supported for Distributors running Microsoft SQL Server 2005 and later.
Namespace: Microsoft.SqlServer.Replication
Assembly: Microsoft.SqlServer.Rmo (in microsoft.sqlserver.rmo.dll)
Syntax
'Declaration
Public Property AgentOffload As Boolean
public bool AgentOffload { get; set; }
public:
property bool AgentOffload {
bool get ();
void set (bool value);
}
/** @property */
public boolean get_AgentOffload ()
/** @property */
public void set_AgentOffload (boolean value)
public function get AgentOffload () : boolean
public function set AgentOffload (value : boolean)
Property Value
A Boolean value. If true, the agent runs on another computer and is launched using a DCOM process. If false, the agent runs on the computer where the agent job was created.
Remarks
Microsoft SQL Server 2000 supported running the Distribution Agent or Merge Agent on another computer and then activating that agent remotely using Distributed Component Object Model (DCOM). Support has been discontinued for Distributors running SQL Server 2005 and later; it has been deprecated for Distributors running earlier versions of SQL Server. Setting the AgentOffload property on an instance of SQL Server 2005 will generate an exception on the server.
When AgentOffload is true, the agent will be launched remotely by way of a DCOM process if is not local.
The AgentOffload property can only be retrieved by members of the sysadmin fixed server role at the Publisher, by members of the db_owner fixed database role on the publication database, or by the user that created the subscription.
The AgentOffload property can only be set by members of the sysadmin fixed server role at the Publisher or by members of the db_owner fixed database role on the publication database.
Retrieving the AgentOffload property is equivalent to executing sp_helpsubscription or sp_helpmergesubscription.
Setting the AgentOffload property is equivalent to executing sp_enableagentoffload, sp_disableagentoffload, sp_addsubscription, or sp_addmergesubscription.
The AgentOffload property is available with SQL Server 2000.
This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.
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
Subscription Class
Subscription Members
Microsoft.SqlServer.Replication Namespace