• Article

MergeSubscriberMonitor.GetSessionDetails Method

Returns detailed information on a Merge Agent session as an array of MergeSessionDetail objects.

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

Syntax

'Declaration
Public Function GetSessionDetails ( _
    sessionId As Integer _
) As MergeSessionDetail()
'Usage
Dim instance As MergeSubscriberMonitor
Dim sessionId As Integer
Dim returnValue As MergeSessionDetail()

returnValue = instance.GetSessionDetails(sessionId)

public MergeSessionDetail[] GetSessionDetails(
    int sessionId
)

public:
array<MergeSessionDetail^>^ GetSessionDetails(
    int sessionId
)

member GetSessionDetails : 
        sessionId:int -> MergeSessionDetail[] 

public function GetSessionDetails(
    sessionId : int
) : MergeSessionDetail[]

Parameters

  • sessionId
    Type: System.Int32
    Identifies a Merge Agent session.

Return Value

Type: array<Microsoft.SqlServer.Replication.MergeSessionDetail[]
An array of MergeSessionDetail objects.

Remarks

Call the GetSessionDetailsDataSet method to return session details as a DataSet object instead of an array of MergeSessionDetail objects.

Calling the GetSessionDetailsDataSet method is equivalent to executing sp_replmonitorhelpmergesessiondetail (Transact-SQL) at the Subscriber.

The GetSessionDetails method can be executed by members of the db_owner or replmonitor fixed database roles in the distribution database, when connected to the Distributor, or in the subscription database, when connected to the Subscriber.

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