RemoveParameter メソッド

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

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

構文

'宣言
Public Sub RemoveParameter ( _
    name As String _
)
'使用
Dim instance As AgentProfile
Dim name As String

instance.RemoveParameter(name)
public void RemoveParameter(
    string name
)
public:
void RemoveParameter(
    String^ name
)
member RemoveParameter : 
        name:string -> unit 
public function RemoveParameter(
    name : String
)

パラメーター

例外

例外 条件
ApplicationException

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

ArgumentException

name パラメータが null Nothing nullptr unit NULL 参照 (Visual Basic では Nothing) であるか、 null Nothing nullptr unit NULL 参照 (Visual Basic では Nothing) 文字を含むか、128 Unicode 文字より長い場合に発生します。

説明

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

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

RemoveParameter を呼び出すと、sp_drop_agent_parameter (Transact-SQL) を実行したのと同じことになります。

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