Share via

AgentProfile.AddParameter Method

  • Article

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 _
)

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
)

Parameters

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

Exceptions

Exception type Condition
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).

This namespace, class, or member is supported only in the .NET Framework 2.0.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

AgentProfile Class
AgentProfile Members
Microsoft.SqlServer.Replication Namespace

Other Resources

How to: Work with Replication Agent Profiles (RMO Programming)