ADO: ActiveX Data Objects

Name

Recordset.UpdateBatch Method — (Versions 2.0, 2.1, 2.5, 2.6)

Synopsis

                     recordset.UpdateBatch AffectRecords
                  

The UpdateBatch method of the Recordset object writes all pending batch updates to disk when called.

Arguments

AffectRecords (AffectEnum)

The optional parameter to the UpdateBatch method is an enumerator of type AffectEnum having the value of adAffectCurrent (1), adAffectGroup (2), or adAffectAll (3, the default).

If the value of AffectRecords is adAffectCurrent, the UpdateBatch method call affects only the pending updates for the current record of the recordset.

If the value of AffectRecords is adAffectGroup, the UpdateBatch method call affects only the pending records that are dictated through the Filter property of the current Recordset object. This property must be already set for the UpdateBatch method to be called with the adAffectGroup parameter.

If the value of AffectRecords is adAffectAll, all records pending updates within the current Recordset object (including those hidden by the Filter property) are affected by the UpdateBatch method.

Description

The UpdateBatch method transmits all pending batch updates to the data source. This method is for use only when in batch update mode, which should be used only with a Keyset or Static cursor.

It is possible to update cached field values multiple times before committing the changes of the pending batch updates. The Update method is automatically called if the UpdateBatch method is called while in edit mode.

If you attempt to ...