The EnumSnapshotAgentSessions method returns a QueryResults object that enumerates session information for Snapshot Agents used by a Distributor.
object.EnumSnapshotAgentSessions( AgentName ,
SessionType , SessionDuration ) as QueryResults
object
Expression that evaluates to an object in the Applies To list.
AgentName
String that identifies a Snapshot Agent by name.
SessionType
Long integer that indicates session type using SQLDMO_
SESSION_TYPE.
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.
HRESULT EnumSnapshotAgentSessions(
SQLDMO_LPCSTR AgentName,
SQLDMO_SESSION_TYPE SessionType,
long SessionDuration,
LPSQLDMOQUERYRESULTS* ppResults);
A QueryResults object that contains one result set defined by these columns.
| Column | Data type | Description |
|---|---|---|
| action_count | integer | Number of session history records. |
| comments | nvarchar(256) | Descriptive text. |
| delivered_commands | integer | Cumulative number of commands delivered in the session. |
| delivery_rate | float | Average number of commands delivered per second. |
| duration | integer | Elapsed time of the session in seconds. |
| error_id | integer | When nonzero, Microsoft® SQL Server™ 2000 error message number. |
| 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. |
In the result set, date and time data returned in start_time and time is 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 19990911 18:12:00.000 is interpreted as 6:12 P.M., September 11, 1999.