MergeSubscriberMonitor.GetSessionsSummary Method (Int32)

Article
12/03/2008

Returns summary information for Merge Agent sessions that have occurred in the past number of hours specified.

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

Syntax

'Declaration
Public Function GetSessionsSummary ( _
    hours As Integer _
) As MergeSessionSummary()

public MergeSessionSummary[] GetSessionsSummary (
    int hours
)

public:
array<MergeSessionSummary^>^ GetSessionsSummary (
    int hours
)

public MergeSessionSummary[] GetSessionsSummary (
    int hours
)

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

Parameters

hours
The past number hours for which to return session information.

Return Value

An array of MergeSessionSummary objects.

Exceptions

Exception type	Condition
ArgumentException	Occurs when one of the properties that defines the subscription is null or not specified.

Remarks

Call the GetSessionsSummary method instead of GetSessionsSummary(Int32) to return all available sessions, up to a maximum of five sessions.

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

The GetSessionsSummary(Int32) 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

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

Share via