INI.Free

Top  Previous  Next

 

Syntax

function INI.Free(var INIFile: pointer): boolean

 

Alternative Names

INI.Close
ibec_ini_Close

 

Description

Use this function to destroy the in memory INI-file object, the variable that holds the pointer is set to NIL.

 

Returns TRUE if the in memory INI-file object is destroyed, FALSE otherwise.

 

See also

INI.Create
INI.Open
INI.UpdateFile
INI.SaveToFile

 

Example

execute udsblock(filepath varchar(500))

returns(valueout varchar(2000), valueoutint integer, valueoutdouble double precision)

as

begin

  /* create in memory INI */

  myini = INI.Create();

  

  /* set the filename and save it empty */

  INI.SaveToFile(myini, filepath || 'new_ini_file.ini');

 

  INI.WriteString(myini, 'section1', 'value1', '1');

  INI.WriteString(myini, 'section1', 'value2', '2');

  INI.WriteString(myini, 'section2', 'value1', '1');

  INI.WriteString(myini, 'section2', 'value2', '2');

 

  /* update the file on disk */

  INI.UpdateFile(myini);

  INI.Free(myini);

    

  /* re-open the file */

  myini = INI.Open(filepath || 'new_ini_file.ini');        

  

  /* return entire contents */

  valueout = INI.GetStrings(myini);

 

  INI.Free(myini);

end