• Article

EnableAgentOffload Method

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 EnableAgentOffload method enables a replication agent to run at a remote Subscriber.

Syntax

object.EnableAgentOffload(bstrJobID, 
[ szServerNetworkName ] )

Parts

  • object
    Expression that evaluates to an object in the Applies To list.

  • bstrJobID
    String that specifies the replication agent job ID.

  • szServerNetworkName
    String that specifies the network computer name of the Subscriber.

Prototype (C/C++)

HRESULT EnableAgentOffload(
SQLDMO_LPCSTR pszJobID, 
SQLDMO_LPCSTR pszServerNetworkName);

Remarks

After creating a push subscription, you can use the EnableAgentOffload method to require that the next execution of a replication agent is performed at a remote Subscriber in a push subscription environment. This technique can improve performance at the Distributor during periods of heavy processing. Using EnableAgentOffload at the Distributor is equivalent to setting the AgentOffloadServer and AgentOffload properties of the MergeSubscription or TransSubscription objects at the Publisher.

Set the bstrJobID parameter to specify the agent job ID to run, and set the optional szServerNetworkName parameter to specify the Subscriber network computer name if it is different from the Subscriber name.

Use the DisableAgentOffload method to prevent the next execution of the agent from being performed at the remote Subscriber.

An application should run the EnableAgentOffload method at the Distributor.

Note

If an application calls EnableAgentOffload on an instance of 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.