AgentProfile.AddParameter Method

Adds a parameter to the replication agent profile.

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)

Syntax

'Declaration
Public Sub AddParameter ( _
    name As String, _
    value As String _
)
'Usage
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
)

Parameters

• name
  Type: System.String
  A String value that specifies the name of a profile parameter.

• value
  Type: System.String
  A String value that specifies a value for the profile parameter.

Exceptions

Exception	Condition
ApplicationException	When the profile represented by the object does not exist on the server.
ArgumentException	When the name parameter is nulla null reference (Nothing in Visual Basic), contains nulla null reference (Nothing in Visual Basic) characters, or is longer than 128-Unicode characters. When the value parameter is nulla null reference (Nothing in Visual Basic), contains nulla null reference (Nothing in Visual Basic) characters or is longer than 255-Unicode characters.

Remarks

The parameter name and value are validated by the server. The profile must exist on the server before parameters can be added. Call EnumParameters to get the parameters that are currently defined for the profile.

The AddParameter method can be called only by a member of the sysadmin fixed server role at the Distributor. AddParameter is equivalent to executing sp_add_agent_parameter (Transact-SQL).

See Also

Reference

AgentProfile Class

Microsoft.SqlServer.Replication Namespace

Other Resources

Work with Replication Agent Profiles (RMO Programming)