Share via


Recordset.CancelUpdate Method

Access Developer Reference

Cancels any pending updates for a Recordset object.

Syntax

expression.CancelUpdate(UpdateType)

expression   A variable that represents a Recordset object.

Parameters

Name Required/Optional Data Type Description
UpdateType Optional Long Set to one of the UpdateTypeEnum values.
Bb220973.vs_note(en-us,office.12).gif  Note
The dbUpdateRegular and dbUpdateBatch values are valid only if batch updating is enabled.
Bb220973.vs_note(en-us,office.12).gif  Note
The dbUpdateRegular and dbUpdateBatch values are valid only if batch updating is enabled.

Remarks

You can use the CancelUpdate method to cancel any pending updates resulting from an Edit or AddNew operation. For example, if a user invokes the Edit or AddNew method and hasn't yet invoked the Update method, CancelUpdate cancels any changes made after Edit or AddNew was invoked.

Check the EditMode property of the Recordset to determine if there is a pending operation that can be canceled.

Note

Using the CancelUpdate method has the same effect as moving to another record without using the Update method, except that the current record doesn't change, and various properties, such as BOF and EOF, aren't updated.

Example

This example shows how the CancelUpdate method is used with the AddNew method.

Visual Basic for Applications
Sub CancelUpdateX()
   Dim dbsNorthwind As Database
   Dim rstEmployees As Recordset
   Dim intCommand As Integer
   Set dbsNorthwind = OpenDatabase("Northwind.mdb")
   Set rstEmployees = dbsNorthwind.OpenRecordset( _
      "Employees", dbOpenDynaset)
   With rstEmployees
      .AddNew
      !FirstName = "Kimberly"
      !LastName = "Bowen"
      intCommand = MsgBox("Add new record for " & _
         !FirstName & " " & !LastName & "?", vbYesNo)
      If intCommand = vbYes Then
         .Update
         MsgBox "Record added."
         ' Delete new record because this is a 
         ' demonstration.
         .Bookmark = .LastModified
         .Delete
      Else
         .CancelUpdate
         MsgBox "Record not added."
      End If
   End With
   dbsNorthwind.Close
End Sub

This example shows how the CancelUpdate method is used with the Edit method.

Visual Basic for Applications
Sub CancelUpdateX2()
   Dim dbsNorthwind As Database
   Dim rstEmployees As Recordset
   Dim strFirst As String
   Dim strLast As String
   Dim intCommand As Integer
   Set dbsNorthwind = OpenDatabase("Northwind.mdb")
   Set rstEmployees = dbsNorthwind.OpenRecordset( _
      "Employees", dbOpenDynaset)
   With rstEmployees
      strFirst = !FirstName
      strLast = !LastName
      .Edit
      !FirstName = "Cora"
      !LastName = "Edmonds"
      intCommand = MsgBox("Replace current name with " & _
         !FirstName & " " & !LastName & "?", vbYesNo)
      If intCommand = vbYes Then
         .Update
         MsgBox "Record modified."
         ' Restore data because this is a demonstration.
         .Bookmark = .LastModified
         .Edit
         !FirstName = strFirst
         !LastName = strLast
         .Update
      Else
         .CancelUpdate
         MsgBox "Record not modified."
      End If
      .Close
   End With
   dbsNorthwind.Close
End Sub

See Also