Compartir a través de

PublisherMonitor.EnumDistributionAgentSessionDetails Method

  • Artículo

Returns detailed information about a Distribution Agent session.

Espacio de nombres: Microsoft.SqlServer.Replication
Ensamblado: Microsoft.SqlServer.Rmo (in microsoft.sqlserver.rmo.dll)

Sintaxis

'Declaración
Public Function EnumDistributionAgentSessionDetails ( _
    agentName As String, _
    sessionId As String _
) As DataSet

public DataSet EnumDistributionAgentSessionDetails (
    string agentName,
    string sessionId
)

public:
DataSet^ EnumDistributionAgentSessionDetails (
    String^ agentName, 
    String^ sessionId
)

public DataSet EnumDistributionAgentSessionDetails (
    String agentName, 
    String sessionId
)

public function EnumDistributionAgentSessionDetails (
    agentName : String, 
    sessionId : String
) : DataSet

Parámetros

  • agentName
    A String value that specifies the name of the Distribution Agent.
  • sessionId
    A String value that represents the data and time of the session for which details are returned. This value can be obtained from the time column returned by the EnumDistributionAgentSessions method.

Valor devuelto

A DataSet object that contains the following columns.

Column

Data type

Description

runstatus

Int32

The running status:

1 = Start

2 = Succeed

3 = In progress

4 = Idle

5 = Retry

6 = Fail

time

DateTime

Time of logging for session detail.

comments

String

Descriptive text.

duration

Int32

Elapsed time of the logged session activity, in seconds.

delivery_rate

Single

Average number of commands delivered per second.

delivery_latency

Int32

Latency, in milliseconds, between the transaction entering the distribution database and being applied to the Subscriber.

(No column name)

Not applicable

Internal use only.

delivered_transactions

Int32

Total number of transactions delivered in the session.

delivered_commands

Int32

Total number of commands delivered in the session.

average_commands

Int32

Average number of commands per transaction delivered in the session.

error_id

Int32

The ID of the error in the MSrepl_errors (Transact-SQL) system table. Use the EnumErrorRecords method to return detailed information about an error.

Notas

The EnumDistributionAgentSessionDetails method can only be called by members of the db_owner or replmonitor fixed database roles on the distribution database.

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

Seguridad para subprocesos

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.

Plataformas

Plataformas de desarrollo

Para obtener una lista de las plataformas compatibles, vea Requisitos de hardware y software para instalar SQL Server 2005.

Plataformas de destino

Para obtener una lista de las plataformas compatibles, vea Requisitos de hardware y software para instalar SQL Server 2005.

Vea también

Referencia

PublisherMonitor Class
PublisherMonitor Members
Microsoft.SqlServer.Replication Namespace

Otros recursos

How to: Programmatically Monitor Replication (RMO Programming)