• Article

PublisherMonitor.EnumSnapshotAgentSessionDetails Method

Returns detailed information about a Snapshot Agent session.

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

Syntax

'Declaration
Public Function EnumSnapshotAgentSessionDetails ( _
    agentName As String, _
    sessionId As String _
) As DataSet
'Usage
Dim instance As PublisherMonitor
Dim agentName As String
Dim sessionId As String
Dim returnValue As DataSet

returnValue = instance.EnumSnapshotAgentSessionDetails(agentName, _
    sessionId)

public DataSet EnumSnapshotAgentSessionDetails(
    string agentName,
    string sessionId
)

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

member EnumSnapshotAgentSessionDetails : 
        agentName:string * 
        sessionId:string -> DataSet 

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

Parameters

  • agentName
    Type: System.String
    A String value that specifies the name of the Log Reader Agent. You can obtain this value from the LogReaderAgentName property of the published database.
  • sessionId
    Type: System.String
    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 EnumLogReaderAgentSessions method.

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.

duration

Int32

Elapsed time of the logged session activity, in seconds.

delivery_rate

Single

Average number of commands delivered per second.

delivered_commands

Int32

Total number of commands delivered in the session.

name

String

Name of the Snapshot Agent job.

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

Commit any property changes to the PublisherMonitor object before calling this method because properties of this object may need to be loaded if they have not been loaded already.

The EnumSnapshotAgentSessionDetails 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.