AgentProfile.RemoveParameter(String) AgentProfile.RemoveParameter(String) AgentProfile.RemoveParameter(String) Method

Definition

Removes an existing parameter from the replication agent profile.

public:
 void RemoveParameter(System::String ^ name);
public void RemoveParameter (string name);
Public Sub RemoveParameter (name As String)
Parameters
name
String String String

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

Exceptions

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

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

Applies to

See Also