Skip to content

Latest commit

 

History

History
61 lines (48 loc) · 2.31 KB

File metadata and controls

61 lines (48 loc) · 2.31 KB
title sp_drop_agent_parameter (Transact-SQL) | Microsoft Docs
ms.custom
ms.date 03/06/2017
ms.prod sql-server-2016
ms.reviewer
ms.suite
ms.technology
replication
ms.tgt_pltfrm
ms.topic language-reference
applies_to
SQL Server
f1_keywords
sp_drop_agent_parameter_TSQL
sp_drop_agent_parameter
helpviewer_keywords
sp_drop_agent_parameter
ms.assetid b99e65ff-9cca-4dce-a2ce-2968de23a76a
caps.latest.revision 29
author BYHAM
ms.author rickbyh
manager jhubbard

sp_drop_agent_parameter (Transact-SQL)

[!INCLUDEtsql-appliesto-ss2008-xxxx-xxxx-xxx_md]

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.

Topic link icon Transact-SQL Syntax Conventions

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

sp_add_agent_parameter (Transact-SQL)
sp_help_agent_parameter (Transact-SQL)
System Stored Procedures (Transact-SQL)