AgentProfile.AddParameter メソッド

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

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

構文

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

instance.AddParameter(name, value)

public void AddParameter(
    string name,
    string value
)

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

member AddParameter : 
        name:string * 
        value:string -> unit

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

パラメーター

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

• value
  型: System.String
  プロファイル パラメーターの値を指定する String 値です。

例外

例外	条件
ApplicationException	オブジェクトによって表されるプロファイルがサーバーに存在しない場合に発生します。
ArgumentException	name パラメーターが nullNULL 参照 (Visual Basic では Nothing) であるか、nullNULL 参照 (Visual Basic では Nothing) 文字を含むか、128 Unicode 文字より長い場合に発生します。 value パラメーターが nullNULL 参照 (Visual Basic では Nothing) であるか、nullNULL 参照 (Visual Basic では Nothing) 文字を含むか、255 Unicode 文字より長い場合に発生します。

説明

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

AddParameter メソッドを呼び出すことができるのは、ディストリビューター側の固定サーバー ロール sysadmin のメンバーだけです。 AddParameter は、sp_add_agent_parameter (Transact-SQL) を実行するのと同じです。

関連項目

参照

AgentProfile クラス

Microsoft.SqlServer.Replication 名前空間

その他の技術情報

レプリケーション エージェント プロファイルを操作する (RMO プログラミング)