Share via

AgentProfile.RemoveParameter Method

  • Article

Removes an existing parameter from the replication agent profile.

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

Syntax

'Declaration
Public Sub RemoveParameter ( _
    name As String _
)

public void RemoveParameter (
    string name
)

public:
void RemoveParameter (
    String^ name
)

public void RemoveParameter (
    String name
)

public function RemoveParameter (
    name : String
)

Parameters

  • name
    A String value that specifies the name of the parameter to be removed.

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.

Remarks

Call EnumParameters to get a list of parameters that exist on the current profile.

The RemoveParameter method can be called only by members of the sysadmin fixed server role on the Distributor.

Calling RemoveParameter is equivalent to executing sp_drop_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)