ReadAgentOffloadInfo Method

構文

object.ReadAgentOffloadInfo( bstrJobID , pbAgentOffload , pszServerNetworkName , pbIndependentAgent )

Parts

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

• bstrJobID
  String that specifies a replication agent job ID.

• pbAgentOffload
  Boolean that returns TRUE or FALSE, depending on whether the agent runs at the Distributor or Subscriber.

• pszServerNetworkName
  String that returns the network computer name of the Subscriber.

• pbIndependentAgent
  Boolean that returns TRUE or FALSE, depending on whether the agent is independent or shared.

Prototype (C/C++)

HRESULT ReadAgentOffloadInfo(
SQLDMO_LPCSTR pszJobID, 
LPBOOL pbAgentOffload, 
SQLDMO_LPBSTR pszServerNetworkName, 
LPBOOL pbIndependentAgent);

注意
SQL Distributed Management Objects (SQL-DMO) strings are always returned as OLE BSTR objects. A C/C++ application obtains a reference to the string. The application must release the reference by using SysFreeString.

説明

Use the ReadAgentOffloadInfo method with the bstrJobID parameter that specifies a replication agent job ID to retrieve information about the offloading status of an agent. If pbAgentOffload returns TRUE, the agent runs at the Subscriber. If pbAgentOffload returns FALSE, the agent runs at the Distributor. If pbIndependentAgent returns TRUE, the agent functions as an independent agent. If pbIndependentAgent returns FALSE, the agent functions as a shared agent.

Use the EnableAgentOffload or DisableAgentOffload methods to change the offloading status of an agent.

注意
If an application calls ReadAgentOffloadInfo 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.

Applies To:

関連項目

参照