Share via

  • Article

AgentProfile.RemoveParameter Method

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 _
)
'Usage
Dim instance As AgentProfile
Dim name As String

instance.RemoveParameter(name)

public void RemoveParameter(
    string name
)

public:
void RemoveParameter(
    String^ name
)

member RemoveParameter : 
        name:string -> unit 

public function RemoveParameter(
    name : String
)

Parameters

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

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.

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.