The GetAgentsStatus method returns a high level report of execution state for replication agents implementing a Distributor.
object.GetAgentsStatus( AgentType , ReturnedStatus , TimeStamp )
| Part | Description |
|---|---|
| object | Expression that evaluates to an object in the Applies To list |
| AgentType | Long integer specifying a type of replication agent as described in Settings |
| ReturnedStatus | Enumerated long value returned |
| TimeStamp | String value returned |
Set the AgentType argument by using these values.
| Constant | Value | Description |
|---|---|---|
| SQLDMOReplAgent_All | 0 | All replication agent types. |
| SQLDMOReplAgent_Distribution | 3 | Distribution Agent |
| SQLDMOReplAgent_LogReader | 2 | Replication transaction log monitoring agent |
| SQLDMOReplAgent_Merge | 4 | Merge Agent |
| SQLDMOReplAgent_Miscellaneous | 5 | Agents not otherwise classified |
| SQLDMOReplAgent_Publishers | -1 | Agents supporting publishers |
| SQLDMOReplAgent_Snapshot | 1 | Snapshot Agent |
Interpret the value returned in the ReturnedStatus argument by using these values.
| Constant | Value | Description |
|---|---|---|
| SQLDMOTask_Failed | 6 | At least one agent-implementing job has failed to execute successfully |
| SQLDMOTask_Idle | 4 | All agent-implementing jobs are scheduled and idle |
| SQLDMOTask_Pending | 0 | All agent-implementing jobs are waiting to start |
| SQLDMOTask_Retry | 5 | At least one agent-implementing job is attempting to execute after a previous failure |
| SQLDMOTask_Running | 3 | At least one agent-implementing job is executing |
| SQLDMOTask_Starting | 1 | One or more agent-implementing jobs are starting |
| SQLDMOTask_Succeeded | 2 | All agent-implementing jobs have executed successfully |
The TimeStamp argument returns a timestamp (binary) value as a hexadecimal character string.
When using Microsoft® Visual Basic® as a SQL-DMO application development environment, you must use the subroutine call statement syntax to execute the GetAgentsStatus method successfully.
HRESULT GetAgentsStatus(
SQLDMO_REPLAGENT_TYPE AgentType,
SQLDMO_TASKSTATUS_TYPE* pRetValStatus,
SQLDMO_LPBSTR pRetValTimeStamp = NULL);
Note 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.