Share via


AgentOffloadServer 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 AgentOffloadServer property specifies the network name of a computer that runs an instance Merge Agent or Distribution Agent.

Syntax

object
.
AgentOffloadServer [=value]

Parts

  • object
    An expression that evaluates to an object in the Applies To list.
  • value
    A string that specifies the network name of a computer that runs Merge Agent 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 Agent or Distribution Agent process. For push subscriptions, Merge Agent or Distribution Agent runs at the Distributor by default. For pull subscriptions, Merge Agent 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 or later" are returned.

Applies To:

MergePullSubscription2 Object

TransPullSubscription2 Object

MergeSubscription2 Object

TransSubscription2 Object

See Also

Reference

AgentOffload Property

Help and Information

Getting SQL Server 2005 Assistance