Share via

  • Article

ReplicationMonitor.EnumQueueReaderAgentSessionDetails Method

Returns detailed information about a Queue Reader Agent session.

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

Syntax

'Declaration
Public Function EnumQueueReaderAgentSessionDetails ( _
    distributionDatabase As String, _
    publicationId As Integer, _
    sessionId As String _
) As DataSet
'Usage
Dim instance As ReplicationMonitor
Dim distributionDatabase As String
Dim publicationId As Integer
Dim sessionId As String
Dim returnValue As DataSet

returnValue = instance.EnumQueueReaderAgentSessionDetails(distributionDatabase, _
    publicationId, sessionId)

public DataSet EnumQueueReaderAgentSessionDetails(
    string distributionDatabase,
    int publicationId,
    string sessionId
)

public:
DataSet^ EnumQueueReaderAgentSessionDetails(
    String^ distributionDatabase, 
    int publicationId, 
    String^ sessionId
)

member EnumQueueReaderAgentSessionDetails : 
        distributionDatabase:string * 
        publicationId:int * 
        sessionId:string -> DataSet 

public function EnumQueueReaderAgentSessionDetails(
    distributionDatabase : String, 
    publicationId : int, 
    sessionId : String
) : DataSet

Parameters

  • distributionDatabase
    Type: System.String
    A String value that specifies the distribution database.

Return Value

Type: System.Data.DataSet
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

String

Time of logging for session detail.

comments

String

Descriptive text.

transaction_id

String

The transaction ID stored with the message, if applicable.

transaction_status

Int32

The status of the transaction.

commands_processed

Int32

The total number of commands processed in the session.

subscriber

String

The name of the Subscriber.

subscriberdb

String

The name of the subscription database.

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.

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 EnumQueueReaderAgentSessionDetails 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.