sp_drop_agent_parameter (T-SQL)

Drops one or all parameters from a profile in the MSagent_parameters table.

Syntax

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

Arguments

[@profile_id =] profile_id

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

[@parameter_name =] 'parameter_name'

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

See Also