AgentProfile.AddParameter Method

  • [アーティクル]

レプリケーション エージェント プロファイルにパラメータを追加します。

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

構文

'宣言
Public Sub AddParameter ( _
    name As String, _
    value As String _
)

public void AddParameter (
    string name,
    string value
)

public:
void AddParameter (
    String^ name, 
    String^ value
)

public void AddParameter (
    String name, 
    String value
)

public function AddParameter (
    name : String, 
    value : String
)

パラメータ

  • name
    プロファイル パラメータの名前を指定する String 値です。
  • value
    プロファイル パラメータの値を指定する String 値です。

例外

例外の種類 条件
ApplicationException

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

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

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

解説

パラメータ名と値がサーバーによって検証されます。パラメータを追加するには、サーバーにそのプロファイルが存在する必要があります。プロファイルに現在定義されているパラメータを取得するには、EnumParameters を呼び出します。

AddParameter メソッドを呼び出すことができるのは、ディストリビュータ側の固定サーバー ロール sysadmin のメンバだけです。AddParameter は、sp_add_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 プログラミング)