AgentProfile.RemoveParameter Method

  • [アーティクル]

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

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

構文

'宣言
Public Sub RemoveParameter ( _
    name As String _
)

public void RemoveParameter (
    string name
)

public:
void RemoveParameter (
    String^ name
)

public void RemoveParameter (
    String name
)

public function RemoveParameter (
    name : String
)

パラメータ

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

例外

例外の種類 条件
ApplicationException

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

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

解説

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

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

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

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

スレッド セーフ

この型の public static (Microsoft Visual Basic では共有 ) メンバは、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

開発プラットフォーム

サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。

対象プラットフォーム

サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。

参照

関連項目

AgentProfile Class
AgentProfile Members
Microsoft.SqlServer.Replication Namespace

その他の技術情報

レプリケーション エージェント プロファイルを扱う方法 (RMO プログラミング)