EnumLogReaderAgentSessionDetails2 Method

  • Article

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

The EnumLogReaderAgentSessionDetails2 method returns a QueryResults object that enumerates detail information for a specified Log Reader Agent session.

Syntax

object
.EnumLogReaderAgentSessionDetails2(
AgentName
,
SessionID
,
lEstimatedNumRecords
)
as 
QueryResults

Parts

  • object
    Expression that evaluates to an object in the Applies To list.
  • AgentName
    String that identifies a Log Reader Agent session by name.
  • SessionID
    String that identifies a session. The SessionID value is specified using the first 21 characters of the time column value in the QueryResults result set returned by the EnumLogReaderAgentSessions2 method.
  • lEstimatedNumRecords
    Long integer that specifies the estimated number of QueryResults rows to return.

Prototype (C/C++)

HRESULT EnumLogReaderAgentSessionDetails2(
SQLDMO_LPCSTR AgentName,
SQLDMO_LPCSTR SessionID,
long lEstimatedNumRecords,
LPSQLDMOQUERYRESULTS* ppResults);

Returns

A QueryResults object that contains one result set defined by these columns.

Column Data type Description

runstatus

integer

Executing state. Interpret using SQLDMO_TASKSTATUS_TYPE.

time

nvarchar(26)

Date and time of message logging.

comments

nvarchar(256)

Descriptive text.

duration

integer

Elapsed time of the session.

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.

delivery_time

integer

Cumulative time measurement for delivery in seconds.

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.

Date part Description

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 (zero padded).

hh

Represents the hour using two digits, a twenty-four hour clock (zero padded).

mm

Represents the minute in two digits (zero padded).

ss

Represents the second in two digits (zero padded).

fff

Represents the fractional part of the second in three digits.

For example, the value 20040512 18:12:00.000 is interpreted as 6:12 P.M., May 12, 2004.

The EnumLogReaderAgentSessionDetails2 method differs from the EnumLogReaderAgentSessionDetails method by including the lEstimatedNumRecords parameter, which allows an application to pass an estimated number of QueryResults rows. This allows the application to avoid the performance overhead associated with repeatedly allocating and freeing memory.

Applies To:

DistributionPublisher2 Object