GetIniFloat - Learn To Code - PlayBASIC Documentation

GetIniFloat

Result# = GetIniFloat(Filename$, Section$, Key$, DefaultValue#)

Parameters:

    Filename$ = the name of the Ini file
    Section$ = the section name
    Key$ = the key name
    DefaultValue# = the default value

Returns:

Result#

GetIniFloat returns a float value from an Ini file. Filename$ specifies the name of the Ini file, Section$ the section and Key$ the key from where the function reads the value. If the function cannot find the key it will return the value specified in DefaultValue#.

If we have an Ini file called "example.ini" that looks like this:

  [SectionA]
  ValueA1=12
  ValueA2=Hello
  ValueA3=1.234

  [SectionB]
  ValueB1=21
  ValueB2=World
  ValueB3=4.321

GetIniFloat("example.ini", "SectionA", "ValueA3", 1.0) would return 1.234
GetIniFloat("example.ini", "SectionB", "ValueB3", 1.0) would return 4.321
GetIniFloat("example.ini", "SectionB", "AValue", 1.0) would return 1.0


Related Info:	GetIniInteger \| GetIniString :