PublisherMonitor.EnumMergeAgentSessionDetails Method

Article
12/03/2008

Returns detailed information about a Merge Agent session.

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

Syntax

'Declaration
Public Function EnumMergeAgentSessionDetails ( _
    agentName As String, _
    sessionId As String _
) As DataSet

public DataSet EnumMergeAgentSessionDetails (
    string agentName,
    string sessionId
)

public:
DataSet^ EnumMergeAgentSessionDetails (
    String^ agentName, 
    String^ sessionId
)

public DataSet EnumMergeAgentSessionDetails (
    String agentName, 
    String sessionId
)

public function EnumMergeAgentSessionDetails (
    agentName : String, 
    sessionId : String
) : DataSet

Parameters

agentName
A String value that specifies the name of the Merge Agent. You can obtain this value from the SynchronizationAgentName property of the merge subscription.

sessionId
A String value that represents the data and time of the session for which details are returned. This value can be obtained from the time column returned by the EnumMergeAgentSessions method.

Return Value

A DataSet object that contains the following columns.

Column	Data type	Description
runstatus	Int32	The running status: 1 = Start 2 = Succeed 3 = In progress 4 = Idle 5 = Retry 6 = Fail
time	DateTime	Time that the session completed.
comments	String	Descriptive text.
duration	Int32	Elapsed time of the logged session activity, in seconds.
delivery_rate	Single	Average number of rows delivered per second.
download_inserts	Int32	The number of inserts applied at the Subscriber.
download_updates	Int32	The number of updates applied at the Subscriber.
download_deletes	Int32	The number of deletes applied at the Subscriber.
download_conflicts	Int32	The number of conflicts that occurred while applying changes at the Subscriber.
upload_inserts	Int32	The number of inserts applied at the Publisher.
upload_updates	Int32	The number of updates applied at the Publisher.
upload_deletes	Int32	The number of deletes applied at the Publisher.
upload_conflicts	Int32	The number of conflicts that occurred while applying changes at the Publisher.
error_id	Int32	The ID of the error in the MSrepl_errors (Transact-SQL) system table. Use the EnumErrorRecords method to return detailed information about an error.

Remarks

You should commit any property changes to the PublisherMonitor object before calling this method because properties of this object may need to be loaded if they have not been loaded already.

The EnumMergeAgentSessionDetails method can only be called by members of the db_owner or replmonitor fixed database roles on the distribution database.

This namespace, class, or member is supported only in version 2.0 of the .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