PublisherMonitor.EnumDistributionAgentSessions(String, Int32, Boolean) PublisherMonitor.EnumDistributionAgentSessions(String, Int32, Boolean) PublisherMonitor.EnumDistributionAgentSessions(String, Int32, Boolean) PublisherMonitor.EnumDistributionAgentSessions(String, Int32, Boolean) Method

Definition

Returns information about Distribution Agent sessions.

public:
 System::Data::DataSet ^ EnumDistributionAgentSessions(System::String ^ agentName, int sessionDuration, bool returnOnlyErrorSessions);
public System.Data.DataSet EnumDistributionAgentSessions (string agentName, int sessionDuration, bool returnOnlyErrorSessions);
member this.EnumDistributionAgentSessions : string * int * bool -> System.Data.DataSet
Public Function EnumDistributionAgentSessions (agentName As String, sessionDuration As Integer, returnOnlyErrorSessions As Boolean) As DataSet

Parameters

agentName
String String String String

A String value that specifies the name of the Distribution Agent job. You can use the SynchronizationAgentName property of the TransSubscription object to obtain this value.

sessionDuration
Int32 Int32 Int32 Int32

An Int32 value that specifies the number of hours before the current time to which to limit the results. For example, a value of 24 will return information about Distribution Agent sessions over the last 24 hours. A value of -1 returns information on the last 100 sessions, and a value of 0 returns information on all sessions.

returnOnlyErrorSessions
Boolean Boolean Boolean Boolean

A Boolean value that specifies whether to return information only on sessions that resulted in an error or on all sessions. If true, only error sessions are returned. If false, all sessions are returned.

Returns

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
start_time String Date and time of last agent execution.
time String Date and time that the session was logged.
comments String Message text logged by the agent.
duration Int32 Elapsed time of the session, in seconds.
delivery_rate Single Average number of commands delivered per second.
delivery_latency Int32 Latency, in milliseconds, between the transaction entering the distribution database and being applied to the Subscriber.
(No column name) Not applicable Internal use only.
delivered_transactions Int32 Total number of transactions delivered in the session.
delivered_commands Int32 Total number of commands delivered in the session.
average_commands Int32 Average number of commands per transaction delivered in the session.
action_count Int32 Number of agent log messages recorded in the session.
error_id Int32 The ID of the error in the [MSrepl_errors (Transact-SQL)](http://msdn.microsoft.com/library/c6e023c1-2c32-4269-8d76-e442ea309e4b) system table. Use the EnumErrorRecords(Int32) 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 EnumDistributionAgentSessions method can only be called by members of the db_owner or replmonitor fixed database roles on the distribution database.

Applies to

See also