sp_help_agent_parameter (Transact-SQL)

MSagent_parameters (Transact-SQL) システム テーブルからプロファイルのすべてのパラメーターを返します。 このストアド プロシージャは、エージェントが動作しているディストリビューター側で任意のデータベースについて実行されます。

トピック リンク アイコン Transact-SQL 構文表記規則

構文

sp_help_agent_parameter [ [ @profile_id = ] profile_id ]

引数

  • [ @profile_id=] profile_id
    MSagent_parameters (Transact-SQL) テーブル内のプロファイルの ID を指定します。 profile_id のデータ型は int で、既定値は -1 です。-1 は、すべてのパラメーターを返すことを示します。

結果セット

列名

データ型

説明

profile_id

int

エージェント プロファイルの ID です。

parameter_name

sysname

パラメーターの名前です。

value

nvarchar(255)

パラメーターの値です。

戻り値

成功した場合は 0 を、失敗した場合は 1 をそれぞれ返します。

説明

sp_help_agent_parameter は、すべての種類のレプリケーションで使用します。

権限

sp_help_agent_parameter を実行できるのは、固定サーバー ロール sysadmin または固定データベース ロール replmonitor のメンバーだけです。

関連項目

参照

sp_add_agent_parameter (Transact-SQL)

sp_drop_agent_parameter (Transact-SQL)

システム ストアド プロシージャ (Transact-SQL)

概念

レプリケーション エージェント プロファイルの操作