PublisherMonitor.EnumSnapshotAgentSessions(String, Int32, Boolean) Метод

Определение

Возвращает информацию о сеансах агента моментальных снимков.

public:
 System::Data::DataSet ^ EnumSnapshotAgentSessions(System::String ^ agentName, int sessionDuration, bool returnOnlyErrorSessions);
public System.Data.DataSet EnumSnapshotAgentSessions (string agentName, int sessionDuration, bool returnOnlyErrorSessions);
member this.EnumSnapshotAgentSessions : string * int * bool -> System.Data.DataSet
Public Function EnumSnapshotAgentSessions (agentName As String, sessionDuration As Integer, returnOnlyErrorSessions As Boolean) As DataSet

Параметры

agentName
String

Значение типа String, указывающее имя агента чтения журнала. Это значение можно получить из свойства LogReaderAgentName опубликованной базы данных.

sessionDuration
Int32

Значение типа Int32, указывающее число прошлых часов, которым ограничиваются результаты. Например, если задать значение 24, будут возвращены сведения о сеансах агента за последние 24 часа. Если задать значение -1, возвращаются сведения за последние 100 сеансов, а если задать значение 0, возвращаются сведения обо всех сеансах.

returnOnlyErrorSessions
Boolean

Значение типа Boolean, которое указывает, возвращаются ли данные только для сеансов, в которых произошла ошибка, или для всех сеансов. Если задано значение true, возвращаются только сеансы с ошибками. Если задано значение false, возвращаются все сеансы.

Возвращаемое значение

Объект DataSet, содержащий следующие столбцы.

Столбец Тип данных Описание
runstatusInt32 Состояние выполнения:

1 = выполнение начато;

2 = успешное выполнение;

3 = выполняется;

4 = бездействует;

5 = повтор;

6 = ошибка.

start_timeString Дата и время последнего выполнения агента.
timeString Дата и время регистрации сеанса.
commentsString Текст сообщения, зарегистрированный агентом.
длительностьInt32 Истекшее время сеанса, в секундах.
delivery_rateSingle Среднее число доставленных команд в секунду.
delivered_commandsInt32 Общее число команд, доставленных за время сеанса.
action_countInt32 Число сообщений журнала агента, записанных в ходе сеанса.
error_idInt32 Идентификатор ошибки в системной таблице [MSrepl_errors (Transact-SQL)](http://msdn.microsoft.com/library/c6e023c1-2c32-4269-8d76-e442ea309e4b) Метод EnumErrorRecords(Int32) позволяет возвращать подробные сведения об ошибке.

Комментарии

Перед вызовом PublisherMonitor этого метода необходимо зафиксировать любые изменения свойств объекта, так как свойства этого объекта, возможно, потребуется загрузить, если они еще не загружены.

Метод EnumSnapshotAgentSessions может вызываться только членами db_owner или replmonitor предопределенных ролей базы данных в базе данных распространителя.

Применяется к

См. также раздел