MergeSubscriberMonitor.GetLastSessionSummary Method

Returns information on the most recent Merge Agent session as a MergeSessionSummary object.

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

Syntax

'Declaration
Public Function GetLastSessionSummary As MergeSessionSummary
'Usage
Dim instance As MergeSubscriberMonitor 
Dim returnValue As MergeSessionSummary 

returnValue = instance.GetLastSessionSummary()
public MergeSessionSummary GetLastSessionSummary()
public:
MergeSessionSummary^ GetLastSessionSummary()
member GetLastSessionSummary : unit -> MergeSessionSummary
public function GetLastSessionSummary() : MergeSessionSummary

Return Value

Type: Microsoft.SqlServer.Replication.MergeSessionSummary
A MergeSessionSummary object that represents the most recent Merge Agent session.

Exceptions

Exception Condition
ArgumentException

Occurs when one of the properties that defines the subscription is null or not specified.

Remarks

The GetLastSessionSummary method only returns the last session. To return earlier sessions, call GetSessionsSummary to return information on up to the last five sessions.

Call GetLastSessionSummaryDataRow to return session data as a DataRow object instead of a MergeSessionSummary object.

Calling the GetLastSessionSummary method is equivalent to executing sp_replmonitorhelpmergesession (Transact-SQL) at the Subscriber.

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

See Also

Reference

MergeSubscriberMonitor Class

Microsoft.SqlServer.Replication Namespace

Other Resources

NIB Programmatically Monitor Replication (RMO Programming)

Subscriber Monitor Sample