EnumQueueReaderAgentView Method
The EnumQueueReaderAgentView method returns a QueryResults object that enumerates execution status for the Queue Reader Agents used by the referenced distribution publication.
Applies To
| DistributionPublication2 Object |
Syntax
object.EnumQueueReaderAgentView( ) as QueryResults
Parts
object
Expression that evaluates to an object in the Applies To list
Prototype (C/C++)
HRESULT EnumQueueReaderAgentView(
LPSQLDMOQUERYRESULTS *ppResults);
Returns
A QueryResults object that contains one result set defined by these columns.
| Column | Data type | Description |
|---|---|---|
| agent_id | integer | Agent identifier. |
| average_commands | integer | Average number of commands. |
| commands_processed | integer | Cumulative number of commands processed in the session. |
| comments | nvarchar(255) | Descriptive text. |
| dbname | sysname | Name of the distribution database. |
| 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™ 2000 error message number. |
| job_id | binary(16) | Identifier of the SQL Server 2000 Agent job that starts the replication agent. |
| local_time_stamp | binary(8) | Timestamp. |
| name | nvarchar(100) | Name of the agent. |
| profile_id | integer | Profile 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. |
Remarks
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 19990911 18:12:00.000 is interpreted as 6:12 P.M., September 11, 1999.
Note If an application calls EnumQueueReaderAgentView on 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" are returned.