PublicationMonitor.EnumSnapshotAgent Method
Returns information for the Snapshot Agent job used by the monitored publication.
Namespace: Microsoft.SqlServer.Replication
Assembly: Microsoft.SqlServer.Rmo (in microsoft.sqlserver.rmo.dll)
Syntax
'Declaration
Public Function EnumSnapshotAgent As DataSet
public DataSet EnumSnapshotAgent ()
public:
DataSet^ EnumSnapshotAgent ()
public DataSet EnumSnapshotAgent ()
public function EnumSnapshotAgent () : DataSet
Return Value
A DataSet object that contains the following columns.
Column |
Data type |
Description |
name |
Replication Agent job name. |
|
status |
The running status: 1 = Start 2 = Succeed 3 = In progress 4 = Idle 5 = Retry 6 = Fail |
|
publisher |
String |
Publisher name. |
publisher_db |
String |
Name of the database published. |
publication |
String |
Publication name. |
start_time |
String |
Date and time of last agent execution. |
time |
String |
Date and time that the session was logged. |
duration |
Int32 |
Elapsed time of the session, in seconds. |
comments |
String |
Message text logged by the agent. |
delivered_transactions |
Int32 |
Total number of transactions delivered in the session. |
delivered_commands |
Int32 |
Total number of commands delivered in the session. |
delivery_rate |
Average number of commands delivered per second. |
|
error_id |
Int32 |
The ID of the error in the MSrepl_errors (Transact-SQL) system table. Use the EnumErrorRecords method to return detailed information about an error. |
job_id |
Byte[16] |
Identifier of the SQL Server Agent job starting the Replication Agent. |
local_job |
When true, the agent job is available at the Distributor. |
|
profile_id |
Int32 |
Profile identifier. |
agent_id |
Int32 |
Agent job identifier. |
local_timestamp |
Byte[8] |
Timestamp of the most recent agent run. |
dynamic_filter_login |
String |
The value used for evaluating the SUSER_SNAME (Transact-SQL) function in parameterized filters that define a partition. |
dynamic_filter_hostname |
String |
The value used for evaluating the HOST_NAME (Transact-SQL) function in parameterized filters that define a partition. |
Remarks
The EnumSnapshotAgent method can only be called by members of the db_owner or replmonitor fixed database roles on the distribution database.
The EnumSnapshotAgent method is available with SQL Server 2000 and SQL Server 2005.
This namespace, class, or member is supported only in version 2.0 of the .NET Framework.
Thread Safety
Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Platforms
Development Platforms
For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.
Target Platforms
For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.
See Also
Reference
PublicationMonitor Class
PublicationMonitor Members
Microsoft.SqlServer.Replication Namespace
Other Resources
How to: Programmatically Monitor Replication (RMO Programming)