次の方法で共有

PublisherMonitor.EnumSnapshotAgentSessions Method

  • [アーティクル]

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

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

構文

'宣言
Public Function EnumSnapshotAgentSessions ( _
    agentName As String, _
    sessionDuration As Integer, _
    returnOnlyErrorSessions As Boolean _
) As DataSet

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

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

public DataSet EnumSnapshotAgentSessions (
    String agentName, 
    int sessionDuration, 
    boolean returnOnlyErrorSessions
)

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

パラメータ

  • agentName
    ログ リーダー エージェントの名前を指定する String 値です。パブリッシュされたデータベースの LogReaderAgentName プロパティからこの値を取得できます。
  • sessionDuration
    結果の制限範囲を示す現在の時刻までの時間数を指定する Int32 値です。たとえば、値 24 は、現在までの過去 24 時間の間のエージェント セッションに関する情報を返します。値 -1 は、現在までの過去 100 セッションに関する情報を返し、値 0 はすべてのセッションに関する情報を返します。
  • returnOnlyErrorSessions
    結果がエラーになったセッションに関する情報のみを返すか、すべてのセッションに関する情報を返すかを指定する Boolean 値です。true の場合、エラー セッションのみが返されます。false の場合、すべてのセッションが返されます。

戻り値

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

列

データ型

説明

runstatus

Int32

実行中の状態です。

1 = 開始

2 = 成功

3 = 進行中

4 = アイドル状態

5 = 再試行

6 = 失敗

start_time

String

前回のエージェント実行の日時です。

time

String

セッションがログに記録された日時です。

comments

String

エージェントによってログに記録されたメッセージ テキストです。

duration

Int32

セッションの経過時間 (秒) です。

delivery_rate

Single

1 秒あたりに配信される平均コマンド数です。

delivered_commands

Int32

セッション中に配信されたコマンドの総数です。

action_count

Int32

セッションで記録されたエージェント ログ メッセージ数です。

error_id

Int32

MSrepl_errors (Transact-SQL) システム テーブル内のエラー ID です。エラーの詳細情報を返すには、EnumErrorRecords メソッドを使用します。

解説

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

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

この名前空間、クラス、またはメンバは、.NET Framework 2.0 でのみサポートされています。

スレッド セーフ

この型の public static (Microsoft Visual Basic では共有 ) メンバは、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

開発プラットフォーム

サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。

対象プラットフォーム

サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。

参照

関連項目

PublisherMonitor Class
PublisherMonitor Members
Microsoft.SqlServer.Replication Namespace

その他の技術情報

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