AgentOffloadServer Property
The AgentOffloadServer property specifies the network name of a computer that runs a Merge or Distribution Agent.
Applies To
MergePullSubscription2 Object | TransPullSubscription2 Object |
MergeSubscription2 Object | TransSubscription2 Object |
Syntax
object.AgentOffloadServer [=value]
Parts
Object
Expression that evaluates to an object in the Applies To list
value
String that specifies the network name of a computer that runs a Merge or Distribution Agent
Data Type
String
Modifiable
Read/write
Prototype (C/C++)
HRESULT GetAgentOffloadServer(SQLDMO_LPBSTR pRetVal);
HRESULT SetAgentOffloadServer(SQLDMO_LPCSTR NewValue);
Remarks
Use the AgentOffloadServer property to specify a computer other than the default computer to run a Merge or Distribution Agent process. For push subscriptions, the Merge or Distribution Agent runs at the Distributor by default. For pull subscriptions, the Merge or Distribution Agent runs at the Subscriber by default.
Prior to setting AgentOffloadServer, set the AgentOffload property to TRUE to override the default setting.
Note If an application calls AgentOffloadServer 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.