ReplicationMonitor.StatusOf(AgentType) Method

Reference

Definition

Namespace:: Microsoft.SqlServer.Replication

Assembly:: Microsoft.SqlServer.Rmo.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 Microsoft::SqlServer::Replication::ReplicationStatus StatusOf(Microsoft::SqlServer::Replication::AgentType agentType);

public Microsoft.SqlServer.Replication.ReplicationStatus StatusOf (Microsoft.SqlServer.Replication.AgentType agentType);

member this.StatusOf : Microsoft.SqlServer.Replication.AgentType -> Microsoft.SqlServer.Replication.ReplicationStatus

Public Function StatusOf (agentType As AgentType) As ReplicationStatus

Parameters

agentType: AgentType

An AgentType value that specifies the type of agent.

Returns

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.

Applies to