ReplicationMonitor.StatusOf Method

Article
12/03/2008

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

public ReplicationStatus StatusOf (
    AgentType agentType
)

public:
ReplicationStatus StatusOf (
    AgentType agentType
)

public ReplicationStatus StatusOf (
    AgentType agentType
)

public function StatusOf (
    agentType : AgentType
) : ReplicationStatus

Parameters

agentType
An AgentType value that specifies the type of agent.

Return Value

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.

The StatusOf method is available with SQL Server 2000 and SQL Server 2005.

This namespace, class, or member is supported only in version 2.0 of the .NET**Framework.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms