EnumSnapshotAgentSessionDetails 메서드
Returns detailed information about a Snapshot Agent session.
네임스페이스: Microsoft.SqlServer.Replication
어셈블리: Microsoft.SqlServer.Rmo.dll의 Microsoft.SqlServer.Rmo
구문
‘선언
Public Function EnumSnapshotAgentSessionDetails ( _
agentName As String, _
sessionId As String _
) As DataSet
‘사용 방법
Dim instance As PublisherMonitor
Dim agentName As String
Dim sessionId As String
Dim returnValue As DataSet
returnValue = instance.EnumSnapshotAgentSessionDetails(agentName, _
sessionId)
public DataSet EnumSnapshotAgentSessionDetails(
string agentName,
string sessionId
)
public:
DataSet^ EnumSnapshotAgentSessionDetails(
String^ agentName,
String^ sessionId
)
member EnumSnapshotAgentSessionDetails :
agentName:string *
sessionId:string -> DataSet
public function EnumSnapshotAgentSessionDetails(
agentName : String,
sessionId : String
) : DataSet
매개 변수
- agentName
형식: System. . :: . .String
A String value that specifies the name of the Log Reader Agent. You can obtain this value from the LogReaderAgentName property of the published database.
- sessionId
형식: System. . :: . .String
A String value that represents the data and time of the session for which details are returned. This value can be obtained from the time column returned by the EnumLogReaderAgentSessions method.
반환 값
형식: System.Data. . :: . .DataSet
A DataSet object that contains the following columns.
Column |
Data type |
Description |
---|---|---|
runstatus |
The running status: 1 = Start 2 = Succeed 3 = In progress 4 = Idle 5 = Retry 6 = Fail |
|
time |
Time of logging for session detail. |
|
comments |
Descriptive text. |
|
duration |
Elapsed time of the logged session activity, in seconds. |
|
delivery_rate |
Average number of commands delivered per second. |
|
delivered_commands |
Total number of commands delivered in the session. |
|
name |
Name of the Snapshot Agent job. |
|
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. |
주의
Commit any property changes to the PublisherMonitor object before calling this method because properties of this object may need to be loaded if they have not been loaded already.
The EnumSnapshotAgentSessionDetails 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.