• Article

CancelAlter Method

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 CancelAlter method marks the end of a unit of change for the object referenced and discards any changes made to object property values.

Syntax

object.CancelAlter( )

Parts

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

Prototype (C/C++)

HRESULT CancelAlter();

Remarks

Outside of a BeginAlter/DoAlter block, each change to a SQL Distributed Management Objects (SQL-DMO) object causes a discrete update to the referenced Microsoft SQL Server 2000 component. Group multiple changes by calling the BeginAlter method.

All changes made after the BeginAlter method call are submitted to SQL Server the next time DoAlter is called. Changes are discarded if the CancelAlter method is called.

Note

Calling CancelAlter restores the SQL-DMO object referenced to its state at the time of the BeginAlter call. It does not refresh the object with current values from an instance of SQL Server.