Sign in Join
FPDoc Onlineexperiment

TCustomIniPropStorage.DoEraseSections procedure

Member of TCustomIniPropStoragepublicIn unit IniPropStorage

Performs actions needed to remove the section section and its subsections from the underlying INI storage.

Declaration

pascal
procedure DoEraseSections(const ARootSection: string); override

Arguments

ARootSection

The path to the section that will be erased.

Description

DoEraseSections is an overridden String function in TCustomIniPropStorage. It implements the abstract virtual method defined in the TCustomPropertyStorage ancestor.

ARootSection contains the name of the section in IniFile removed in the method.

DoEraseSections gets a list of section names found in the INI file, and calls IniFile.EraseSection to remove the section along with its identifiers and values. Other child sections which have ARootSection as a prefix are removed as well.

DoEraseSections is used in the SaveProperties method, and is assigned as the OnEraseSetion event handler for the RTTI TPropsStorage instance used in the method.

See also

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