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)
Syntax
'Declaration
Public Function GetSessionsSummary As MergeSessionSummary()
'Usage
Dim instance As MergeSubscriberMonitor
Dim returnValue As MergeSessionSummary()
returnValue = instance.GetSessionsSummary()
public MergeSessionSummary[] GetSessionsSummary()
public:
array<MergeSessionSummary^>^ GetSessionsSummary()
member GetSessionsSummary : unit -> MergeSessionSummary[]
public function GetSessionsSummary() : MergeSessionSummary[]
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
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.
See Also
Reference
Microsoft.SqlServer.Replication Namespace