sp_drop_agent_parameter (Transact-SQL)

Applies to: SQL Server

Drops one or all parameters from a profile in the MSagent_parameters table. This stored procedure is executed at the Distributor where the agent is running, on any database.

Transact-SQL syntax conventions

Syntax

syntaxsql

sp_drop_agent_parameter
    [ @profile_id = ] profile_id
    [ , [ @parameter_name = ] N'parameter_name' ]
[ ; ]

Arguments

[ @profile_id = ] profile_id

The ID of the profile for which a parameter is to be dropped. @profile_id is int, with no default.

[ @parameter_name = ] N'parameter_name'

The name of the parameter to be dropped. @parameter_name is sysname, with a default of %. If %, all parameters for the specified profile are dropped.

Return code values

0 (success) or 1 (failure).

Remarks

sp_drop_agent_parameter is used in all types of replication.

Permissions

Only members of the sysadmin fixed server role can execute sp_drop_agent_parameter.

Related content

• sp_add_agent_parameter (Transact-SQL)
• sp_help_agent_parameter (Transact-SQL)
• System stored procedures (Transact-SQL)