PublisherMonitor.EnumSnapshotAgentSessionDetails メソッド

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

スナップショットエージェントセッションに関する詳細情報を返します。

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

構文

'宣言
Public Function EnumSnapshotAgentSessionDetails ( _
    agentName As String, _
    sessionId As String _
) As DataSet
'使用
Dim instance As PublisherMonitor 
Dim agentName As String 
Dim sessionId As String 
Dim returnValue As DataSet 

returnValue = instance.EnumSnapshotAgentSessionDetails(agentName, _
    sessionId)

public DataSet EnumSnapshotAgentSessionDetails(
    string agentName,
    string sessionId
)

public:
DataSet^ EnumSnapshotAgentSessionDetails(
    String^ agentName, 
    String^ sessionId
)

member EnumSnapshotAgentSessionDetails : 
        agentName:string * 
        sessionId:string -> DataSet

public function EnumSnapshotAgentSessionDetails(
    agentName : String, 
    sessionId : String
) : DataSet

パラメーター

agentName
型: System.String
ログリーダーエージェントの名前を指定する String 値です。パブリッシュされたデータベースの LogReaderAgentName プロパティからこの値を取得できます。

sessionId
型: System.String
返される詳細情報の取得元となるセッションのデータおよび時刻を表す String 値です。この値は、EnumLogReaderAgentSessions メソッドによって返される time 列から取得できます。

戻り値

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

列	データ型	説明
runstatus	Int32	実行ステータスです。 1 = 開始 2 = 成功 3 = 進行中 4 = アイドル状態 5 = 再試行 6 = 失敗
time	String	セッション詳細のログを記録する時刻です。
comments	String	説明のテキストです。
duration	Int32	セッションの利用状況をログに記録してからの経過時間 (秒) です。
delivery_rate	Single	1 秒あたりに配信される平均コマンド数です。
delivered_commands	Int32	セッション中に配信されたコマンドの総数です。
name	String	スナップショットエージェントジョブの名前です。
error_id	Int32	MSrepl_errors (Transact-SQL) システムテーブル内のエラー ID です。エラーの詳細情報を返すには、EnumErrorRecords メソッドを使用します。

説明

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

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

次の方法で共有

PublisherMonitor.EnumSnapshotAgentSessionDetails メソッド

構文

パラメーター

戻り値

説明

関連項目

参照

その他の技術情報

その他のリソース