TCustomIniFile class

In unit IniFiles

Abstract ini file object.

Declaration

pascal

TCustomIniFile = class

Descends from it: TIniFile TJSONIniFile

Description

TCustomIniFile implements all calls for manipulating a .ini. It does not implement any of this behaviour, the behaviour must be implemented in a descendent class like TIniFile or TMemIniFile.

Since TCustomIniFile is an abstract class, it should never be created directly. Instead, one of the TIniFile or TMemIniFile classes should be created.

Properties

`Encoding`	public	Encoding of the ini file.
`FileName`	public	Name of the .ini file.
`Options`	public	Options currently in effect.
`EscapeLineFeeds`	public	Should linefeeds be escaped ?
`CaseSensitive`	public	Are key and section names case sensitive.
`StripQuotes`	public	Should quotes be stripped from string values.
`FormatSettingsActive`	public	Is FormatSettings used or not.
`BoolTrueStrings`	public	Strings to recognize as boolean True values.
`BoolFalseStrings`	public	Strings to recognize as boolean False values.
`OwnsEncoding`	public	Does the ini file instance own the encoding ?

Methods

`SetEncoding`	protected
`Create`	public	Instantiate a new instance of TCustomIniFile.
`Destroy`	public	Remove the TCustomIniFile instance from memory.
`SetBoolStringValues`	public	Set the boolean string values to use when writing to file.
`SectionExists`	public	Check if a section exists.
`ReadString`	public	Read a string valued key.
`WriteString`	public	Write a string value.
`ReadInteger`	public	Read an integer value from the file.
`WriteInteger`	public	Write an integer value.
`ReadInt64`	public	Read an Int64 value.
`WriteInt64`	public	Write an Int64 value.
`ReadBool`	public
`WriteBool`	public	Write boolean value.
`ReadDate`	public	Read a date value.
`ReadDateTime`	public	Read a Date/Time value.
`ReadFloat`	public	Read a floating point value.
`ReadTime`	public	Read a time value.
`ReadBinaryStream`	public	Read binary data.
`WriteDate`	public	Write date value.
`WriteDateTime`	public	Write date/time value.
`WriteFloat`	public	Write a floating-point value.
`WriteTime`	public	Write time value.
`WriteBinaryStream`	public	Write binary data.
`ReadSection`	public	Read the key names in a section.
`ReadSections`	public	Read the list of sections.
`ReadSectionValues`	public	Read names and values of a section.
`EraseSection`	public	Clear a section.
`DeleteKey`	public	Delete a key from a section.
`UpdateFile`	public	Update the file on disk.
`ValueExists`	public	Check if a value exists.

Fields

FormatSettings public Format settings to use when reading date/time/float values.

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