EnumDistributionAgentSessionDetails Method (SQL-DMO)

The EnumDistributionAgentSessionDetails method returns a QueryResults object enumerating detail information for a specified Distribution Agent session.

Applies To

DistributionPublisher Object

Syntax

object.EnumDistributionAgentSessionDetails( AgentName,
SessionID ) as QueryResults

Part Description
object Expression that evaluates to an object in the Applies To list.
AgentName String identifying a Distributor Agent session by name.
SessionID String identifying a session. The SessionID value is specified by using the first 21 characters of the time column value in the QueryResults result set returned by the EnumDistributionAgentSessions method.

Returns

A QueryResults object containing one result set defined by these columns.

Column Data type Description
runstatus integer Executing state. Interpret by using SQLDMO_TASKSTATUS_TYPE.
time nvarchar(26) Time of logging for session detail.
comments nvarchar(256) Descriptive text.
duration integer Elapsed time of the logged session activity.
delivery_rate float Average number of commands delivered per second.
delivery_latency integer Latency, in milliseconds, between the transaction entering the distribution database and being applied to the Subscriber.
  integer Reserved. Returns 0 always.
delivered_transactions integer Cumulative number of transactions delivered in the session.
delivered_commands integer Cumulative number of commands delivered in the session.
average_commands integer Average number of commands per transaction delivered in the session.
error_id integer When nonzero, Microsoft® SQL Server™ error message number.

Remarks

In the result set, date and time data returned in time is formatted as YYYYMMDD hh:mm:ss.fff where: YYYY represents the year in four digits; MM represents the month in two digits (zero padded); DD represents the day of the month in two digits; hh represents the hour using two digits, a twenty-four hour clock and zero padding; mm represents the minute in two digits (zero padded); ss represents the second in two digits (zero padded); and fff represents the fractional part of the second in three digits.

Prototype (C/C++)

HRESULT EnumDistributionAgentSessionDetails(
SQLDMO_LPCSTR AgentName,
SQLDMO_LPCSTR SessionID,
LPSQLDMOQUERYRESULTS* ppResults);

  


(c) 1988-98 Microsoft Corporation. All Rights Reserved.