AgentsStatus Property

SQL-DMO

SQL-DMO

AgentsStatus Property

The AgentsStatus property returns a value representing, roughly, the current state of replication jobs affecting a distribution database or providing services for a distribution Publisher.

Applies To
DistributionDatabase Object
Syntax

object.AgentsStatus

Parts

object

Expression that evaluates to an object in the Applies To list

Data Type

Long

Modifiable

Read-only

Prototype (C/C++)

HRESULT GetAgentsStatus(SQLDMO_TASKSTATUS_TYPE* pRetVal);

Returns
Constant Value Description
SQLDMOTask_Failed 6 At least one job has failed to execute successfully
SQLDMOTask_Idle 4 All jobs are scheduled and idle
SQLDMOTask_Pending 0 All jobs are waiting to start
SQLDMOTask_Retry 5 At least one job is attempting to execute after a previous failure
SQLDMOTask_Running 3 At least one job is executing
SQLDMOTask_Starting 1 One or more jobs are starting
SQLDMOTask_Succeeded 2 All jobs have successfully executed