Sign in Join
FPDoc Onlineexperiment

TCustomIniFile.ReadString function

Member of TCustomIniFilepublicIn unit IniFiles

Read a string valued key.

Declaration

pascal
function ReadString(const Section: string; const Ident: string; 
 const Default: string): string; virtual; abstract

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 string.

Description

ReadString reads the key Ident in section Section, and returns the value as a string. If the specified key or section do not exist, then the value in Default is returned. Note that if the key exists, but is empty, an empty string will be returned.

See also

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