EnumMergeAgentViews2 Method
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 EnumMergeAgentViews2 method returns a QueryResults object that enumerates execution state for all replication merge agents.
Syntax
object
.EnumMergeAgentViews2( [ fExcludeAnonymous ] )as QueryResults
Parts
object
Expression that evaluates to an object in the Applies To list.fExcludeAnonymous
Boolean that specifies whether anonymous Merge Agent views are enumerated. Default is FALSE.
Prototype (C/C++)
HRESULT EnumMergeAgentViews2(
LPSQLDMOQUERYRESULTS *ppResults,
BOOL fExcludeAnonymous);
Returns
A QueryResults object that contains one result set defined by these columns.
Column |
Data type |
Description |
|---|---|---|
agent_id |
integer |
Agent identifier. |
comments |
nvarchar(256) |
Descriptive text. |
dbname |
nvarchar(129) |
Distribution database name. |
delivery_rate |
integer |
Average number of transactions per second. |
duration |
integer |
Elapsed time of the logged session activity. |
error_id |
integer |
When nonzero, the Microsoft SQL Server error message number of the most recent error. |
job_id |
binary(22) |
Identifier of the SQL Server Agent job starting the replication agent. |
local_job |
bit |
When TRUE, the SQL Server Agent job executes at the Distributor. When FALSE, the SQL Server Agent job executes at the Subscriber. |
local_timestamp |
binary(14) |
Timestamp. |
name |
nvarchar(101) |
Merge Agent name. |
profile_id |
integer |
Profile identifier. Links this agent to the agent profile used to establish runtime parameters such as timeout and batch size values. |
publication |
nvarchar(129) |
Publication name. |
publisher |
nvarchar(129) |
Publisher name. |
publisher_conflicts |
integer |
Number of conflicts at the Publisher. |
publisher_db |
nvarchar(129) |
Name of published database. |
publisher_/deletecount |
integer |
Number of deletes at the Publisher. |
publisher_/insertcount |
integer |
Number of inserts at the Publisher. |
publisher_/updatecount |
integer |
Number of updates at the Publisher. |
start_time |
nvarchar(25) |
Date and time at which agent session started. |
status |
integer |
Agent status. Interpret using SQLDMO_TASKSTATUS_TYPE. |
subscriber |
nvarchar(129) |
Subscriber name. |
subscriber_conflicts |
integer |
Number of conflicts at the Subscriber. |
subscriber_db |
nvarchar(129) |
Name of database implementing the subscription. |
subscriber_/deletecount |
integer |
Number of deletes at the Subscriber. |
subscriber_/insertcount |
integer |
Number of inserts at the Subscriber. |
subscriber_/updatecount |
integer |
Number of updates at the Subscriber. |
subscription_type |
integer |
Direction of subscription (push or pull) interpreted using SQLDMO_SUBSCRIPTION_TYPE. |
time |
nvarchar(25) |
Date and time of last session log. |
Remarks
The EnumMergeAgentViews2 method extends the functionality of the EnumMergeAgentViews method by including the optional fExcludeAnonymous parameter. When fExcludeAnonymous is set to TRUE, anonymous Merge Agent views are not enumerated.
In the result set, date and time data returned in start_time and 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.
Note
If an application calls EnumMergeAgentViews2 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 or later" are returned.