Remove Method (Collections)

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 referenced database, agent, or replication object from an instance of Microsoft SQL Server connected to, and removes the SQL Distributed Management Objects (SQL-DMO) object from its containing collection.

Syntax

object
.Remove(
index
)

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.

Prototype (C/C++)

HRESULT RemoveByOrd(long lOrdinal);
HRESULT RemoveByName(SQLDMO_LPCSTR szName);

Remarks

For more information about using the Remove method of a SQL-DMO collection, including information on privilege required, see documentation for the collection.

Note

Some collections support the Remove method using only the ordinal location of the object within the collection. For more information, see documentation for the collection.

If an application calls Remove with the MergeArticles collection after the initial snapshot is created, a new snapshot must be generated.

Applies To:

AlertCategories Collection	MergeArticles Collection
Alerts Collection	MergePublications Collection
BackupDevices Collection	MergeSubscriptions Collection
Checks Collection	MergePullSubscriptions Collection
Columns Collection	MergeSubsetFilters Collection
DatabaseRoles Collection	Names Collection
Databases Collection	OperatorCategories Collection
DBFiles Collection	RegisteredServers Collection
Defaults Collection	RegisteredSubscribers Collection
DistributionArticles Collection	RemoteLogins Collection
DistributionDatabases Collection	RemoteServers Collection
DistributionPublications Collection	Rules Collection
DistributionPublishers Collection	ServerGroups Collection
DistributionSubscriptions Collection	StoredProcedures Collection
FileGroups Collection	Tables Collection
FullTextCatalogs Collection	TargetServerGroups Collection
Indexes Collection	TargetServers Collection
JobCategories Collection	TransArticles Collection
Jobs Collection	TransPublications Collection
JobSchedules Collection	TransPullSubscriptions Collection
JobSteps Collection	TransSubscriptions Collection
Keys Collection	Triggers Collection
LinkedServerLogins Collection	UserDefinedDatatypes Collection
LinkedServers Collection	UserDefinedFunctions Collection
LogFiles2 Collection	Users Collection
Logins Collection	Views Collection