ReplicationMonitor.EnumSnapshotAgents Method

Returns information on Snapshot Agent jobs at the monitored Distributor.

Namespace: Microsoft.SqlServer.Replication
Assembly: Microsoft.SqlServer.Rmo (in microsoft.sqlserver.rmo.dll)

Syntax

'Declaration
Public Function EnumSnapshotAgents As DataSet

public DataSet EnumSnapshotAgents ()

public:
DataSet^ EnumSnapshotAgents ()

public DataSet EnumSnapshotAgents ()

public function EnumSnapshotAgents () : DataSet

Return Value

A DataSet object that contains the following columns.

Column	Data type	Description
db_name	String	Name of the distribution database.
name	String	Replication agent job name.
status	Int32	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 publication database.
publication	String	Name of the publication.
start_time	String	Date and time of the 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	Single	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	Boolean	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 defines a partition.
dynamic_filter_hostname	String	The value used for evaluating the HOST_NAME (Transact-SQL) function in parameterized filters that defines a partition.

Remarks

You should commit any property changes to the ReplicationMonitor object before calling this method because properties of this object may need to be loaded if they have not been loaded already.

The EnumSnapshotAgents method can only be called by members of the db_owner or replmonitor fixed database roles on the distribution database.

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

ReplicationMonitor Class
ReplicationMonitor Members
Microsoft.SqlServer.Replication Namespace

Other Resources

How to: Programmatically Monitor Replication (RMO Programming)