Remove Method (Operators)

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

The Remove method drops the indicated SQL Server Agent operator, optionally reassigning notifications to a named operator.

Syntax

object.Remove(index, [ NewName ] )

Parts

  • object
    Expression that evaluates to an object in the Applies To list.

  • index
    Long integer that indicates the ordinal location of the object within the collection or string indicating the name of the object.

  • NewName
    Optional. A string that identifies an existing operator by name.

Prototype (C/C++)

HRESULT RemoveByOrd(long lOrdinal,
SQLDMO_LPCSTR NewName = NULL);
HRESULT RemoveByName(SQLDMO_LPCSTR szName,
SQLDMO_LPCSTR NewName = NULL);

Remarks

The Remove method removes the SQL Distributed Management Objects (SQL-DMO) object referencing the dropped operator from the Operators collection.

Applies To: