MergeSubscriberMonitor.RefreshSessionSummary Method (MergeSessionSummary%)

Refreshes information in a MergeSessionSummary object that represents a specific Merge Agent session.

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

Syntax

'Declaration
Public Sub RefreshSessionSummary ( _
    ByRef mss As MergeSessionSummary _
)
'Usage
Dim instance As MergeSubscriberMonitor
Dim mss As MergeSessionSummary

instance.RefreshSessionSummary(mss)
public void RefreshSessionSummary(
    ref MergeSessionSummary mss
)
public:
void RefreshSessionSummary(
    MergeSessionSummary^% mss
)
member RefreshSessionSummary : 
        mss:MergeSessionSummary byref -> unit 
public function RefreshSessionSummary(
    mss : MergeSessionSummary
)

Parameters

Exceptions

Exception Condition
ArgumentException

Occurs when the passed MergeSessionSummary object is null or empty.

Remarks

RefreshSessionSummary(MergeSessionSummary%) refreshes session information in the passed MergeSessionSummary object.

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

The RefreshSessionSummary() 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.