GetSessionsSummary Method ()
Collapse the table of content
Expand the table of content

MergeSubscriberMonitor.GetSessionsSummary Method ()

Returns all available summary information on Merge Agent sessions.

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

public MergeSessionSummary[] GetSessionsSummary ()
public MergeSessionSummary[] GetSessionsSummary ()
public function GetSessionsSummary () : MergeSessionSummary[]

Return Value

An array of MergeSessionSummary objects.

Exception typeCondition

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

The GetSessionsSummary method returns MergeSessionSummary objects for up to five sessions.

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

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

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.

Development Platforms

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

Target Platforms

Community Additions

© 2015 Microsoft