PublisherMonitor.EnumMergeAgentSessions2 メソッド

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

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

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

構文

'宣言
Public Function EnumMergeAgentSessions2 ( _
    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.EnumMergeAgentSessions2(agentName, _
    sessionDuration, returnOnlyErrorSessions)

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

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

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

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

パラメーター

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

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

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

戻り値

型: System.Data.DataSet
次の列を含む DataSet オブジェクトです。

列	データ型	説明
Session_id	Int32	エージェントジョブセッションの ID。
Status	Int32	エージェント実行状態。 1 = 開始 2 = 成功 3 = 実行中 4 = アイドル状態 5 = 再試行 6 = 失敗
StartTime	DateTime	エージェントジョブセッションが開始した時刻です。
EndTime	DateTime	エージェントジョブセッションが完了した時刻です。
Duration	Int32	エージェントジョブセッションの累積時間 (秒) です。
UploadedCommands	Int32	エージェントジョブセッションの間にアップロードされたコマンド数です。
DownloadedCommands	Int32	エージェントジョブセッションの間にダウンロードされたコマンド数です。
ErrorMessages	Int32	エージェントジョブセッションの間に生成されたエラーメッセージの数です。
ErrorID	Int32	発生したエラーの ID です。
PercentageDone	Decimal	アクティブなセッションで既に配信された総変更数の推定割合です。
TimeRemaining	Int32	アクティブなセッションでの推定残り秒数。
CurrentPhase	Int32	アクティブなセッションの現在のフェーズです。次のいずれかの値をとります。 1 = アップロード 2 = ダウンロード
LastMessage	String	セッション中にマージエージェントによってログに記録された最後のメッセージです。

説明

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

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

EnumMergeAgentSessions2 を呼び出すと、sp_replmonitorhelpmergesession (Transact-SQL) を実行したのと同じことになります。

次の方法で共有

PublisherMonitor.EnumMergeAgentSessions2 メソッド

構文

パラメーター

戻り値

説明

関連項目

参照

その他の技術情報

その他のリソース