MergeSubscriberMonitor.RefreshSessionSummary Method (ref MergeSessionSummary)

Article
12/03/2008

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 _
)

public void RefreshSessionSummary (
    ref MergeSessionSummary mss
)

public:
void RefreshSessionSummary (
    MergeSessionSummary^% mss
)

public void RefreshSessionSummary (
    /** @ref */ MergeSessionSummary mss
)

JScript does not support passing value-type arguments by reference.

Parameters

mss
A MergeSessionSummary object that is the session to be refreshed.

Exceptions

Exception type	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.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms