DeleteCommand Property

SQL-DMO

SQL-DMO

DeleteCommand Property

The DeleteCommand property exposes the Transact-SQL script used to replicate a row delete operation in a transactional replication article.

Applies To
TransArticle Object
Syntax

object.DeleteCommand [= value]

Parts

object

Expression that evaluates to an object in the Applies To list

value

String that specifies a Transact-SQL script

Data Type

String

Modifiable

Read/write

Prototype (C/C++)

HRESULT GetDeleteCommand(SQLDMO_LPBSTR pRetVal);

HRESULT SetDeleteCommand(SQLDMO_LPCSTR NewValue);

Note  SQL-DMO strings are always returned as OLE BSTR objects. A C/C++ application obtains a reference to the string. The application must release the reference using SysFreeString.

Remarks

The format and contents of the DeleteCommand property must match those specified for the @del_cmd argument of the system stored procedure sp_addarticle. For more information, see sp_addarticle.

Note  If an application sets DeleteCommand after the initial snapshot has been created, a new snapshot must be generated and reapplied to each subscription. Snapshots are applied when the next scheduled snapshot and distribution agent run.