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 のメンバだけです。