EnumLogReaderAgentSessions2 Method
この機能は、将来のバージョンの Microsoft SQL Server では削除される予定です。 新しい開発作業では、この機能の使用を避け、現在この機能を使用しているアプリケーションは修正するようにしてください。
The EnumLogReaderAgentSessions2method returns a QueryResults object that enumerates execution status data for the Log Reader Agent specified.
構文
object.EnumLogReaderAgentSessions2(AgentName,SessionType, SessionDuration,lEstimatedNumRecords)as QueryResults
Parts
object
Expression that evaluates to an object in the Applies To list.AgentName
String that identifies a Log Reader Agent by name.SessionType
Long integer that indicates session type as described in Settings.SessionDuration
Long integer that specifies a number of hours. Restricts result set membership to those sessions launched within the number of hours specified. Use 0 to specify no restriction on agent session start time.lEstimatedNumRecords
Long integer that specifies the estimated number of QueryResults rows to return.
Prototype (C/C++)
HRESULT EnumLogReaderAgentSessions2(
SQLDMO_LPCSTR AgentName,
SQLDMO_SESSION_TYPE SessionType,
long SessionDuration,
long lEstimatedNumRecords,
LPSQLDMOQUERYRESULTS* ppResults);
Settings
Set SessionType using these values.
Constant |
Value |
Description |
|---|---|---|
SQLDMOSession_All |
1 |
Output contains log information for all sessions for agent. |
SQLDMOSession_Errors |
2 |
Output contains log information only for those execution attempts ending in error. |
Returns
A QueryResults object that contains one result set defined by these columns.
Column |
Data type |
Description |
|---|---|---|
runstatus |
integer |
Executing state. Interpret using SQLDMO_TASKSTATUS_TYPE. |
start_time |
nvarchar(26) |
Date and time of last scheduled execution. |
time |
nvarchar(26) |
Date and time of message logging. |
comments |
nvarchar(256) |
Descriptive text. |
duration |
integer |
Elapsed time of the session in seconds. |
delivery_rate |
float |
Average number of commands delivered per second. |
delivery_latency |
integer |
Latency, in milliseconds, between the Publisher committing a transaction and that transaction entering the distribution database. |
delivery_time |
integer |
Cumulative time measurement for delivery in seconds. |
delivered_/transactions |
integer |
Cumulative number of transactions delivered in the session. |
delivered_commands |
integer |
Cumulative number of commands delivered in the session. |
average_commands |
integer |
Average number of commands per transaction delivered in the session. |
action_count |
integer |
Number of session history records. |
error_id |
integer |
When nonzero, Microsoft SQL Server error message number. |
説明
In the result set, date and time data returned in start_time and timeis 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.
The EnumLogReadAgentSessions2 method differs from the EnumLogReaderAgentSessions method by including the lEstimatedNumRecords parameter, which allows the application to pass an estimated number of QueryResults rows. This allows an application to avoid the performance overhead associated with repeatedly allocating and freeing memory.