AgentProfile.RemoveParameter(String) メソッド

定義

レプリケーション エージェント プロファイルから、既存のパラメーターを削除します。

public:
 void RemoveParameter(System::String ^ name);
public void RemoveParameter (string name);
member this.RemoveParameter : string -> unit
Public Sub RemoveParameter (name As String)

パラメーター

name
String

削除するパラメーターの名前を指定する String 値です。

例外

オブジェクトによって表されるプロファイルがサーバーに存在しない場合に発生します。

name パラメーターが null であるか、null 文字を含むか、128 Unicode 文字より長い場合に発生します。

注釈

現在のプロファイルに存在するパラメーターの一覧を取得するには、EnumParameters を呼び出します。

RemoveParameter メソッドを呼び出すことができるのは、ディストリビューターの固定サーバー ロール sysadmin のメンバーだけです。

呼び出し RemoveParameter は、 sp_drop_agent_parameterの実行 (Transact-SQL) と同じです。

適用対象

こちらもご覧ください