EnumQueueReaderAgentSessions Method
TOC
Collapse the table of content
Expand the table of content

EnumQueueReaderAgentSessions Method

SQL Server 2008 R2

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 EnumQueueReaderAgentSessions method returns a QueryResults object that enumerates execution status data about Queue Reader Agent sessions operating on the specified publication.


object
.EnumQueueReaderAgentSessions(
lPublicationID
,
SessionType
,
SessionDuration
,
lEstimatedNumRecords 
)
as
QueryResults

object

Expression that evaluates to an object in the Applies To list.

lPublicationID

Long integer that identifies the publication by ID.

SessionType

SQLDMO_SESSION_TYPE constant that indicates the session type as described in Settings.

SessionDuration

Long integer that specifies the number of hours. Restricts result set membership to those sessions launched within the specified number of hours. Use 0 to specify no restriction on agent session start time.

lEstimatedNumRecords

Long integer that specifies the estimated number of QueryResults rows to return.

HRESULT EnumQueueReaderAgentSessions(
long lPublicationID, 
SQLDMO_SESSION_TYPE SessionType, 
long SessionDuration, 
long lEstimatedNumRecords,
LPSQLDMOQUERYRESULTS *ppResults);

Set SessionType using these values.

Constant

Value

Description

SQLDMOSession_All

1

Output contains log information for all sessions for agent.

SQLDMOSession_Errors

2

Output contains log information only for those execution attempts ending in error.

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

Column

Data type

Description

action_count

integer

Total number of session details.

average_commands

integer

Average number of commands.

commands_processed

integer

Cumulative number of commands processed in the session.

comments

nvarchar(255)

Descriptive text.

delivery_latency

integer

Latency, in milliseconds, between a transaction entering the queue and being applied to the Publisher.

delivery_rate

integer

Average number of commands delivered per second.

duration

integer

Elapsed time of the logged session activity in seconds.

error_id

integer

When nonzero, indicates a Microsoft SQL Server error message number.

publication_id

integer

Publication identifier.

start_time

nvarchar(24)

Date and time at which agent session started.

status

integer

Queue Reader Agent status.

time

nvarchar(24)

Date and time of last logged message.

transactions_processed

integer

Cumulative number of transactions processed in the session.

In the result set, date and time data returned in start_time and time are 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 EnumQueueReaderAgentSessions method includes 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.

NoteNote

If an application calls EnumQueueReaderAgentSessionson an instance of SQL Server version 7.0, the constant, SQLDMO_E_SQL80ONLY, and the message "This property or method requires Microsoft SQL Server 2000 or later" are returned.

Community Additions

ADD
Show:
© 2016 Microsoft