Artikel
03/30/2012

EnumDistributionAgentSessions-Methode

Returns information about Distribution Agent sessions.

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

Syntax

'Declaration
Public Function EnumDistributionAgentSessions ( _
    agentName As String, _
    sessionDuration As Integer, _
    returnOnlyErrorSessions As Boolean _
) As DataSet
'Usage
Dim instance As PublisherMonitor
Dim agentName As String
Dim sessionDuration As Integer
Dim returnOnlyErrorSessions As Boolean
Dim returnValue As DataSet

returnValue = instance.EnumDistributionAgentSessions(agentName, _
    sessionDuration, returnOnlyErrorSessions)

public DataSet EnumDistributionAgentSessions(
    string agentName,
    int sessionDuration,
    bool returnOnlyErrorSessions
)

public:
DataSet^ EnumDistributionAgentSessions(
    String^ agentName, 
    int sessionDuration, 
    bool returnOnlyErrorSessions
)

member EnumDistributionAgentSessions : 
        agentName:string * 
        sessionDuration:int * 
        returnOnlyErrorSessions:bool -> DataSet

public function EnumDistributionAgentSessions(
    agentName : String, 
    sessionDuration : int, 
    returnOnlyErrorSessions : boolean
) : DataSet

Parameter

agentName
Typ: System. . :: . .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
Typ: System. . :: . .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
Typ: System. . :: . .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.

Rückgabewert

Typ: System.Data. . :: . .DataSet
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) system table. Use the EnumErrorRecords method to return detailed information about an error.

Hinweise

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.

This namespace, class, or member is supported only in version 2.0 of the .NET Framework.