MergeSubscriberMonitor.GetSessionsSummary Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Returns summary information on Merge Agent sessions.
Overloads
| GetSessionsSummary(Int32) |
Returns summary information for Merge Agent sessions that have occurred in the past number of hours specified. |
| GetSessionsSummary() |
Returns all available summary information on Merge Agent sessions. |
Remarks
This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.
GetSessionsSummary(Int32)
Returns summary information for Merge Agent sessions that have occurred in the past number of hours specified.
public:
cli::array <Microsoft::SqlServer::Replication::MergeSessionSummary ^> ^ GetSessionsSummary(int hours);public Microsoft.SqlServer.Replication.MergeSessionSummary[] GetSessionsSummary (int hours);member this.GetSessionsSummary : int -> Microsoft.SqlServer.Replication.MergeSessionSummary[]Public Function GetSessionsSummary (hours As Integer) As MergeSessionSummary()Parameters
- hours
- Int32
The past number hours for which to return session information.
Returns
An array of MergeSessionSummary objects.
Exceptions
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
Applies to
GetSessionsSummary()
Returns all available summary information on Merge Agent sessions.
public:
cli::array <Microsoft::SqlServer::Replication::MergeSessionSummary ^> ^ GetSessionsSummary();public Microsoft.SqlServer.Replication.MergeSessionSummary[] GetSessionsSummary ();member this.GetSessionsSummary : unit -> Microsoft.SqlServer.Replication.MergeSessionSummary[]Public Function GetSessionsSummary () As MergeSessionSummary()Returns
An array of MergeSessionSummary objects.
Exceptions
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.