AgentProfile.AddParameter(String, String) Method

Reference

Definition

Namespace:: Microsoft.SqlServer.Replication

Assembly:: Microsoft.SqlServer.Rmo.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Adds a parameter to the replication agent profile.

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

public void AddParameter (string name, string value);

member this.AddParameter : string * string -> unit

Public Sub AddParameter (name As String, value As String)

Parameters

name: String

A String value that specifies the name of a profile parameter.

value: String

A String value that specifies a value for the profile parameter.

Exceptions

ApplicationException

When the profile represented by the object does not exist on the server.

ArgumentException

When the name parameter is null, contains null characters, or is longer than 128-Unicode characters.

When the value parameter is null, contains null 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).

Applies to