MergeSubscriberMonitor.GetSessionsSummary Method (Int32)
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()
'Usage
Dim instance As MergeSubscriberMonitor
Dim hours As Integer
Dim returnValue As MergeSessionSummary()
returnValue = instance.GetSessionsSummary(hours)
public MergeSessionSummary[] GetSessionsSummary(
int hours
)
public:
array<MergeSessionSummary^>^ GetSessionsSummary(
int hours
)
member GetSessionsSummary :
hours:int -> MergeSessionSummary[]
public function GetSessionsSummary(
hours : int
) : MergeSessionSummary[]
Parameters
- hours
Type: System.Int32
The past number hours for which to return session information.
Return Value
Type: array<Microsoft.SqlServer.Replication.MergeSessionSummary[]
An array of MergeSessionSummary objects.
Exceptions
| Exception | 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.
See Also
Reference
Microsoft.SqlServer.Replication Namespace