AgentOffload Property
This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.
The AgentOffload property specifies whether Merge Agent or Distribution Agent runs on a computer other than the computer on which the agent is created.
Syntax
object
.
AgentOffload [=value]
Parts
- object
An expression that evaluates to an object in the Applies To list
- value
TRUE or FALSE
Data Type
Boolean
Modifiable
Read/write
Prototype (C/C++)
HRESULT GetAgentOffload(LPBOOL pRetVal);
HRESULT SetAgentOffload(BOOL NewValue);
Remarks
Set the AgentOffload property to TRUE to run Merge Agent or Distribution Agent on a remote computer that is not the computer on which the agent is created. Specify the remote computer name by setting the AgentOffloadServer property after setting AgentOffload to TRUE. Specifying a remote computer to run Merge Agent or Distribution Agent can enhance performance if the default computer must handle many agent processes.
If AgentOffload is not set or is set to FALSE, Merge Agent or Distribution Agent runs on the default computer on which the agent is created. By default, Merge Agent and Distribution Agent run at the Distributor for push subscriptions, and they run at the Subscriber for pull subscriptions.
Note
If an application calls AgentOffload on an instance of Microsoft SQL Server version 7.0, the constant, SQLDMO_E_SQL80ONLY, and the message "This property or method requires Microsoft SQL Server 2000 and later" are returned.