EnumSnapshotAgents méthode
Returns information on Snapshot Agent jobs at the monitored Distributor.
Espace de noms : Microsoft.SqlServer.Replication
Assembly : Microsoft.SqlServer.Rmo (dans Microsoft.SqlServer.Rmo.dll)
Syntaxe
'Déclaration
Public Function EnumSnapshotAgents As DataSet
'Utilisation
Dim instance As ReplicationMonitor
Dim returnValue As DataSet
returnValue = instance.EnumSnapshotAgents()
public DataSet EnumSnapshotAgents()
public:
DataSet^ EnumSnapshotAgents()
member EnumSnapshotAgents : unit -> DataSet
public function EnumSnapshotAgents() : DataSet
Valeur de retour
Type : System.Data. . :: . .DataSet
A DataSet object that contains the following columns.
Column |
Data type |
Description |
|---|---|---|
db_name |
Name of the distribution database. |
|
name |
Replication agent job name. |
|
status |
The running status: 1 = Start 2 = Succeed 3 = In progress 4 = Idle 5 = Retry 6 = Fail |
|
publisher |
Publisher name. |
|
publisher_db |
Name of the publication database. |
|
publication |
Name of the publication. |
|
start_time |
Date and time of the last agent execution. |
|
time |
Date and time that the session was logged. |
|
duration |
Elapsed time of the session, in seconds. |
|
comments |
Message text logged by the agent. |
|
delivered_transactions |
Total number of transactions delivered in the session. |
|
delivered_commands |
Total number of commands delivered in the session. |
|
delivery_rate |
Average number of commands delivered per second. |
|
error_id |
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 |
Profile identifier. |
|
agent_id |
Agent job identifier. |
|
local_timestamp |
Byte[8] |
Timestamp of the most recent agent run. |
dynamic_filter_login |
The value used for evaluating the SUSER_SNAME (Transact-SQL) function in parameterized filters that defines a partition. |
|
dynamic_filter_hostname |
The value used for evaluating the HOST_NAME (Transact-SQL) function in parameterized filters that defines a partition. |
Notes
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.