PublisherMonitor.EnumSnapshotAgentSessions(String, Int32, Boolean) メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
スナップショット エージェント セッションに関する情報を返します。
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.DataSetPublic 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 オブジェクトです。
| 列 | データ型 | 説明 |
|---|---|---|
| runstatus | Int32 | 実行ステータスです。 1 = 開始 2 = 成功 3 = 進行中 4 = アイドル 5 = 再試行 6 = 失敗 |
| start_time | String | 前回のエージェント実行の日時です。 |
| time | String | セッションがログに記録された日時です。 |
| comments | String | エージェントによってログに記録されたメッセージ テキストです。 |
| duration | Int32 | セッションの経過時間 (秒) です。 |
| delivery_rate | Single | 1 秒あたりに配信される平均コマンド数です。 |
| delivered_commands | Int32 | セッション中に配信されたコマンドの総数です。 |
| action_count | Int32 | セッションで記録されたエージェント ログ メッセージ数です。 |
| error_id | Int32 | [MSrepl_errors (Transact-SQL)](http://msdn.microsoft.com/library/c6e023c1-2c32-4269-8d76-e442ea309e4b) システム テーブル内のエラーの ID。 エラーの詳細情報を返すには、EnumErrorRecords(Int32) メソッドを使用します。 |
注釈
PublisherMonitor オブジェクトのプロパティがまだ読み込まれていない場合は、読み込むことが必要になる可能性があるため、このメソッドを呼び出す前にこのオブジェクトのプロパティに対する変更をすべてコミットする必要があります。
メソッドはEnumSnapshotAgentSessions、ディストリビューション データベースの または replmonitor 固定データベース ロールのdb_ownerメンバーによってのみ呼び出すことができます。