Export (0) Print
Expand All
Expand Minimize

EnumSnapshotAgentSessionDetails Method

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

The EnumSnapshotAgentSessionDetails method returns a QueryResults object that enumerates detail information for a specified Snapshot Agent session.


object
.EnumSnapshotAgentSessionDetails(
AgentName 
,
SessionID
)
as 
QueryResults

object

Expression that evaluates to an object in the Applies To list.

AgentName

String that identifies a Snapshot Agent by name.

SessionID

String that identifies a session. The SessionID value is specified using the first 21 characters of the time column value in the QueryResults result set returned by the EnumSnapshotAgentSessions method.

HRESULT EnumSnapshotAgentSessionDetails(
SQLDMO_LPCSTR AgentName,
SQLDMO_LPCSTR SessionID,
LPSQLDMOQUERYRESULTS* ppResults);

A QueryResults object that contains one result set defined by these columns.

Column

Data type

Description

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 error message number.

name

nvarchar(101)

Agent session name.

runstatus

integer

Executing state. Interpret using SQLDMO_TASKSTATUS_TYPE.

time

nvarchar(26)

Date and time of message logging.

In the result set, date and time data returned in 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.

Community Additions

ADD
Show:
© 2014 Microsoft