Sign in Join
FPDoc Onlineexperiment

TCustomIniFile.ReadFloat function

Member of TCustomIniFilepublicIn unit IniFiles

Read a floating point value.

Declaration

pascal
function ReadFloat(const Section: string; const Ident: string; 
 Default: Double): Double; virtual

Arguments

Section

Section to read Ident from.

Ident

Name of key to retrieve value from.

Default

Default value to return when the key Ident does not exist.

Function result

Value of Ident as a floating point value.

Description

ReadFloat reads the key Ident in section Section, and returns the value as a float ( Double). If the specified key or section do not exist, then the value in Default is returned. If the key exists, but contains an invalid float value, Default is also returned. The international settings of the SysUtils are taken into account when deciding if the read value is a correct float.

See also

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