Sign in Join
FPDoc Onlineexperiment

TCollection.BeginUpdate procedure

Member of TCollectionpublicIn unit Classes

Start an update batch.

Declaration

pascal
procedure BeginUpdate; virtual

Description

BeginUpdate is called at the beginning of a batch update. It raises the update count with 1.

Call BeginUpdate at the beginning of a series of operations that will change the state of the collection. This will avoid the call to Update for each operation. At the end of the operations, a corresponding call to EndUpdate must be made. It is best to do this in the context of a Try ... finally block:

With MyCollection Do
    try
      BeginUpdate;
      // Some Lengthy operations
    finally
      EndUpdate;
    end;

This insures that the number of calls to BeginUpdate always matches the number of calls to EndUpdate, even in case of an exception.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.