AgentProfile.RemoveParameter 方法

Removes an existing parameter from the replication agent profile.

命名空间:  Microsoft.SqlServer.Replication
程序集:  Microsoft.SqlServer.Rmo(在 Microsoft.SqlServer.Rmo.dll 中)

语法

声明
Public Sub RemoveParameter ( _
    name As String _
)
用法
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
)

参数

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

异常

异常 条件
ApplicationException

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

ArgumentException

When the name parameter is nullnull 引用(在 Visual Basic 中为 Nothing), contains nullnull 引用(在 Visual Basic 中为 Nothing) characters, or is longer than 128-Unicode characters.

注释

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

请参阅

参考

AgentProfile 类

Microsoft.SqlServer.Replication 命名空间

其他资源

使用复制代理配置文件(RMO 编程)