PublisherMonitor.EnumMergeAgentSessions2(String, Int32, Boolean) メソッド

定義

マージ エージェント セッションに関する追加情報を返します。

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

パラメーター

agentName
String

マージ エージェント ジョブの名前を指定する String 値です。 SynchronizationAgentName オブジェクトの MergeSubscription プロパティを使用して、この値を取得できます。

sessionDuration
Int32

結果の制限範囲を示す現在の時刻までの時間数を指定する Int32 値です。 たとえば、値 24 は、現在までの過去 24 時間の間のエージェント セッションに関する情報を返します。 値 -1 は、現在までの過去 100 セッションに関する情報を返し、値 0 はすべてのセッションに関する情報を返します。

returnOnlyErrorSessions
Boolean

Booleanエラーが発生したセッションに関する情報のみを返すか、すべてのセッションで情報を返すかを示す 値。 true の場合、エラー セッションのみが返されます。 false の場合、すべてのセッションが返されます。

戻り値

次の列を含む DataSet オブジェクトです。

データ型 説明
Session_idInt32 エージェント ジョブ セッションの ID。
StatusInt32 エージェントの実行状態:

1 = 開始

2 = 成功

3 = 進行中

4 = アイドル

5 = 再試行

6 = 失敗

StartTimeDateTime エージェント ジョブ セッションが開始した時刻です。
EndTimeDateTime エージェント ジョブ セッションが完了した時刻です。
DurationInt32 エージェント ジョブ セッションの累積時間 (秒) です。
UploadedCommandsInt32 エージェント ジョブ セッションの間にアップロードされたコマンド数です。
DownloadedCommandsInt32 エージェント ジョブ セッションの間にダウンロードされたコマンド数です。
ErrorMessagesInt32 エージェント ジョブ セッションの間に生成されたエラー メッセージの数です。
ErrorIDInt32 発生したエラーの ID です。
PercentageDoneDecimal アクティブなセッションで既に配信された総変更数の推定割合です。
TimeRemainingInt32 アクティブなセッションの残りの推定秒数。
CurrentPhaseInt32 アクティブなセッションの現在のフェーズです。次のいずれかの値をとります。

1 = アップロード

2 = ダウンロード

LastMessageString セッション中にマージ エージェントによってログに記録された最後のメッセージです。

注釈

PublisherMonitor オブジェクトのプロパティがまだ読み込まれていない場合は、読み込むことが必要になる可能性があるため、このメソッドを呼び出す前にこのオブジェクトのプロパティに対する変更をすべてコミットする必要があります。

メソッドはEnumMergeAgentSessions2、ディストリビューション データベースの または replmonitor 固定データベース ロールのdb_ownerメンバーによってのみ呼び出すことができます。

呼び出し EnumMergeAgentSessions2 は、 sp_replmonitorhelpmergesessionの実行 (Transact-SQL) と同じです。

適用対象

こちらもご覧ください