Share via


ReplicationMonitor.StatusOf Method

Returns the overall status for replication agents at the monitored Distributor by agent type.

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)

Syntax

'Declaration
Public Function StatusOf ( _
    agentType As AgentType _
) As ReplicationStatus
'Usage
Dim instance As ReplicationMonitor 
Dim agentType As AgentType 
Dim returnValue As ReplicationStatus 

returnValue = instance.StatusOf(agentType)
public ReplicationStatus StatusOf(
    AgentType agentType
)
public:
ReplicationStatus StatusOf(
    AgentType agentType
)
member StatusOf : 
        agentType:AgentType -> ReplicationStatus
public function StatusOf(
    agentType : AgentType
) : ReplicationStatus

Parameters

Return Value

Type: Microsoft.SqlServer.Replication.ReplicationStatus
A ReplicationStatus object.

Remarks

The highest status number for any agent specified by AgentType is returned.

The StatusOf method can only be retrieved by members of the sysadmin fixed server role at the Distributor or by members of the db_owner or replmonitor fixed database roles on the distribution database.

See Also

Reference

ReplicationMonitor Class

Microsoft.SqlServer.Replication Namespace