• Article

DisableAgentOffload 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 DisableAgentOffload method prevents a replication agent from offloading to a remote server.

Applies To:

DistributionPublisher2 Object

 

Syntax

object
.DisableAgentOffload(
bstrJobID 
)

Parts

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

  • BstrJobID
    String that specifies the replication agent job ID.

Prototype (C/C++)

HRESULT DisableAgentOffload(SQLDMO_LPCSTR pszJobID);

Remarks

After using the EnableAgentOffload method to offload execution of a replication agent to a Subscriber, use DisableAgentOffload to require the agent to run at the Distributor.

Note

If an application calls DisableAgentOffload 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" are returned.