ReplicationMonitor.EnumMiscellaneousAgents Method
Returns information on jobs for miscellaneous replication agents at the monitored Distributor.
Namespace: Microsoft.SqlServer.Replication
Assembly: Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)
Syntax
'Declaration
Public Function EnumMiscellaneousAgents As DataSet
'Usage
Dim instance As ReplicationMonitor
Dim returnValue As DataSet
returnValue = instance.EnumMiscellaneousAgents()
public DataSet EnumMiscellaneousAgents()
public:
DataSet^ EnumMiscellaneousAgents()
member EnumMiscellaneousAgents : unit -> DataSet
public function EnumMiscellaneousAgents() : DataSet
Return Value
Type: System.Data.DataSet
A DataSet object that contains the following columns.
Column |
Data type |
Description |
|---|---|---|
name |
Replication agent job name. |
|
agent_type |
Type of miscellaneous replication agent. |
|
status |
The running status: 1 = Start 2 = Succeed 3 = In progress 4 = Idle 5 = Retry 6 = Fail |
|
message |
Message text logged by the agent. |
|
start_time |
Date and time of the last agent execution. |
|
run_duration |
Elapsed time of the session, in seconds. |
|
job_id |
Byte[16] |
Identifier of the SQL Server Agent job starting the replication agent. |
local_timestamp |
Byte[8] |
Timestamp of the most recent agent run. |
Remarks
You should commit any property changes to the ReplicationMonitor object before calling this method because properties of this object may need to be loaded if they have not been loaded already.
The EnumMiscellaneousAgents method can only be called by members of the db_owner or replmonitor fixed database roles on the distribution database.
See Also
Reference
Microsoft.SqlServer.Replication Namespace