AgentProfile.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
)
パラメーター
- name
型: System.String
削除するパラメーターの名前を指定する String 値です。
例外
| 例外 | 条件 |
|---|---|
| ApplicationException | オブジェクトによって表されるプロファイルがサーバーに存在しない場合に発生します。 |
| ArgumentException | name パラメーターが nullNULL 参照 (Visual Basic では Nothing) であるか、nullNULL 参照 (Visual Basic では Nothing) 文字を含むか、128 Unicode 文字より長い場合に発生します。 |
説明
現在のプロファイルに存在するパラメーターの一覧を取得するには、EnumParameters を呼び出します。
RemoveParameter メソッドを呼び出すことができるのは、ディストリビューターの固定サーバー ロール sysadmin のメンバーだけです。
RemoveParameter を呼び出すと、sp_drop_agent_parameter (Transact-SQL) を実行したのと同じことになります。
関連項目
参照
Microsoft.SqlServer.Replication 名前空間