Sign in Join
FPDoc Onlineexperiment

TCustomIniFile.ReadInteger function

Member of TCustomIniFilepublicIn unit IniFiles

Read an integer value from the file.

Declaration

pascal
function ReadInteger(const Section: string; const Ident: string; 
 Default: LongInt): LongInt; 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 an integer.

Description

ReadInteger reads the key Ident in section Section, and returns the value as an integer. If the specified key or section do not exist, then the value in Default is returned. If the key exists, but contains an invalid integer value, Default is also returned.

See also

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