PublisherMonitor.EnumMergeAgentSessions2 Method
マージ エージェント セッションに関する追加情報を返します。
名前空間: Microsoft.SqlServer.Replication
アセンブリ: Microsoft.SqlServer.Rmo (microsoft.sqlserver.rmo.dll 内)
構文
'宣言
Public Function EnumMergeAgentSessions2 ( _
agentName As String, _
sessionDuration As Integer, _
returnOnlyErrorSessions As Boolean _
) As DataSet
public DataSet EnumMergeAgentSessions2 (
string agentName,
int sessionDuration,
bool returnOnlyErrorSessions
)
public:
DataSet^ EnumMergeAgentSessions2 (
String^ agentName,
int sessionDuration,
bool returnOnlyErrorSessions
)
public DataSet EnumMergeAgentSessions2 (
String agentName,
int sessionDuration,
boolean returnOnlyErrorSessions
)
public function EnumMergeAgentSessions2 (
agentName : String,
sessionDuration : int,
returnOnlyErrorSessions : boolean
) : DataSet
パラメータ
- agentName
マージ エージェント ジョブの名前を指定する String 値です。MergeSubscription オブジェクトの SynchronizationAgentName プロパティを使用して、この値を取得できます。
- sessionDuration
結果の制限範囲を示す現在の時刻までの時間数を指定する Int32 値です。たとえば、値 24 は、現在までの過去 24 時間の間のエージェント セッションに関する情報を返します。値 -1 は、現在までの過去 100 セッションに関する情報を返し、値 0 はすべてのセッションに関する情報を返します。
- returnOnlyErrorSessions
結果がエラーになったセッションに関する情報のみを返すか、すべてのセッションに関する情報を返すかを指定する Boolean 値です。true の場合、エラー セッションのみが返されます。false の場合、すべてのセッションが返されます。
戻り値
次の列を含む DataSet オブジェクトです。
列 |
データ型 |
説明 |
Session_id |
Int32 |
エージェント ジョブ セッションの ID です。 |
Status |
Int32 |
エージェント実行の状態です。 1 = 開始 2 = 成功 3 = 進行中 4 = アイドル状態 5 = 再試行 6 = 失敗 |
StartTime |
エージェント ジョブ セッションが開始した時刻です。 |
|
EndTime |
DateTime |
エージェント ジョブ セッションが完了した時刻です。 |
Duration |
Int32 |
エージェント ジョブ セッションの累積時間 (秒) です。 |
UploadedCommands |
Int32 |
エージェント ジョブ セッションの間にアップロードされたコマンド数です。 |
DownloadedCommands |
Int32 |
エージェント ジョブ セッションの間にダウンロードされたコマンド数です。 |
ErrorMessages |
Int32 |
エージェント ジョブ セッションの間に生成されたエラー メッセージの数です。 |
ErrorID |
Int32 |
発生したエラーの ID です。 |
PercentageDone |
アクティブなセッションで既に配信された総変更数の推定割合です。 |
|
TimeRemaining |
Int32 |
アクティブなセッションにおける推定残存秒数です。 |
CurrentPhase |
Int32 |
アクティブなセッションの現在のフェーズです。次のいずれかの値をとります。 1 = アップロード 2 = ダウンロード |
LastMessage |
String |
セッション中にマージ エージェントによってログに記録された最後のメッセージです。 |
解説
PublisherMonitor オブジェクトのプロパティがまだ読み込まれていない場合は、読み込む必要があるため、このメソッドを呼び出す前にこのオブジェクトのプロパティに対する変更を、すべてコミットする必要があります。
EnumMergeAgentSessions2 メソッドを呼び出せるのは、ディストリビューション データベースの固定データベース ロール db_owner または replmonitor のメンバだけです。
EnumMergeAgentSessions2 を呼び出すと、sp_replmonitorhelpmergesession (Transact-SQL) を実行したのと同じことになります。
この名前空間、クラス、またはメンバは、.NET Framework 2.0 でのみサポートされています。
スレッド セーフ
この型の public static (Microsoft Visual Basic では共有 ) メンバは、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。
プラットフォーム
開発プラットフォーム
サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。
対象プラットフォーム
サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。
参照
関連項目
PublisherMonitor Class
PublisherMonitor Members
Microsoft.SqlServer.Replication Namespace
PublisherMonitor.EnumMergeAgentSessionDetails2 Method
PublisherMonitor.EnumMergeAgentSessions Method