sp_help_agent_default (Transact-SQL)
パラメーターとして渡されたエージェント タイプについて、既定の構成の ID を取得します。 このストアド プロシージャは、任意のデータベース上のディストリビューター側で実行されます。
.gif "トピック リンク アイコン")
構文
sp_help_agent_default [ @profile_id= ] profile_id OUTPUT
, [ @agent_type = ] agent_type
引数
[ @profile_id=] profile_idOUTPUT
エージェントの種類の既定の構成の ID を指定します。 profile_id のデータ型は int で、既定値はありません。profile_id は OUTPUT パラメーターでもあり、エージェントの種類の既定の構成の ID を返します。[ @agent_type=] 'agent_type'
エージェントの種類を指定します。 agent_type のデータ型は int で、既定値はありません。次のいずれかの値を指定します。値
説明
1
スナップショット エージェント
2
ログ リーダー エージェント
3
ディストリビューション エージェント
4
マージ エージェント
9
キュー リーダー エージェント
リターン コードの値
成功した場合は 0 を、失敗した場合は 1 をそれぞれ返します。
説明
sp_help_agent_default は、すべての種類のレプリケーションで使用します。
権限
sp_help_agent_default を実行できるのは、固定サーバー ロール sysadmin または固定データベース ロール replmonitor のメンバーだけです。