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

定義

名前空間:

Microsoft.SqlServer.Replication

アセンブリ:

Microsoft.SqlServer.Rmo.dll

ディストリビューション エージェント セッションに関する情報を返します。

public:
 System::Data::DataSet ^ EnumDistributionAgentSessions(System::String ^ agentName, int sessionDuration, bool returnOnlyErrorSessions);

public System.Data.DataSet EnumDistributionAgentSessions (string agentName, int sessionDuration, bool returnOnlyErrorSessions);

member this.EnumDistributionAgentSessions : string * int * bool -> System.Data.DataSet

Public Function EnumDistributionAgentSessions (agentName As String, sessionDuration As Integer, returnOnlyErrorSessions As Boolean) As DataSet

パラメーター

agentName

String

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

sessionDuration

Int32

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

returnOnlyErrorSessions

Boolean

結果がエラーになったセッションに関する情報のみを返すか、すべてのセッションに関する情報を返すかを指定する Boolean 値です。 true の場合、エラー セッションのみが返されます。 false の場合、すべてのセッションが返されます。

戻り値

DataSet

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

列	データ型	説明
runstatus	Int32	実行ステータスです。 1 = 開始 2 = 成功 3 = 進行中 4 = アイドル 5 = 再試行 6 = 失敗
start_time	String	エージェントの最後の実行日時。
time	String	セッションがログに記録された日時です。
comments	String	エージェントによってログに記録されたメッセージ テキストです。
duration	Int32	セッションの経過時間 (秒) です。
delivery_rate	Single	1 秒あたりに配信される平均コマンド数です。
delivery_latency	Int32	トランザクションがディストリビューション データベースに登録されてからサブスクライバーに適用されるまでの待機時間 (ミリ秒) です。
(列名なし)	適用できません	内部使用のみです。
delivered_transactions	Int32	セッションで配信されたトランザクションの合計数。
delivered_commands	Int32	セッション中に配信されたコマンドの総数です。
average_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 オブジェクトのプロパティがまだ読み込まれていない場合は、読み込むことが必要になる可能性があるため、このメソッドを呼び出す前にこのオブジェクトのプロパティに対する変更をすべてコミットする必要があります。

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

こちらもご覧ください

• レプリケーションをプログラムから監視する方法 (RMO プログラミング)