PublisherMonitor.EnumDistributionAgentSessions メソッド

[アーティクル]
02/01/2013

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

名前空間: Microsoft.SqlServer.Replication
アセンブリ: Microsoft.SqlServer.Rmo (Microsoft.SqlServer.Rmo.dll)

構文

'宣言
Public Function EnumDistributionAgentSessions ( _
    agentName As String, _
    sessionDuration As Integer, _
    returnOnlyErrorSessions As Boolean _
) As DataSet
'使用
Dim instance As PublisherMonitor 
Dim agentName As String 
Dim sessionDuration As Integer 
Dim returnOnlyErrorSessions As Boolean 
Dim returnValue As DataSet 

returnValue = instance.EnumDistributionAgentSessions(agentName, _
    sessionDuration, returnOnlyErrorSessions)

public DataSet EnumDistributionAgentSessions(
    string agentName,
    int sessionDuration,
    bool returnOnlyErrorSessions
)

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

member EnumDistributionAgentSessions : 
        agentName:string * 
        sessionDuration:int * 
        returnOnlyErrorSessions:bool -> DataSet

public function EnumDistributionAgentSessions(
    agentName : String, 
    sessionDuration : int, 
    returnOnlyErrorSessions : boolean
) : DataSet

パラメーター

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

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

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

戻り値

型: System.Data.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) システムテーブル内のエラー ID です。エラーの詳細情報を返すには、EnumErrorRecords メソッドを使用します。

説明

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

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

次の方法で共有

PublisherMonitor.EnumDistributionAgentSessions メソッド

構文

パラメーター

戻り値

説明

関連項目

参照

その他の技術情報

その他のリソース