Syntax

object.AgentOffload [=value]

Parts

object

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 the Merge 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 a Merge 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, the Merge or Distribution Agent runs on the default computer on which the agent is created. By default, Merge or Distribution Agents run at the Distributor for push subscriptions, and 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" are returned.

See Also