WriteINI

Definition

function WriteINI(Section, KeyName, NewString, FileName: string): Boolean;

Availability

SCAR Divi 3.00 > Current

• Before SCAR Divi 3.21 WriteINI did not have a return value.

Description

Writes data to a file with an INI structure. The function creates a new file specified by the path FileName when it does not yet exist, else it opens the existing file at that path and changes it without destroying the current contents of the file. The function writes a value specified by NewString at the key specified by KeyName in the section specified by Section. The function returns true if it was successful in writing the value. If Section or KeyName are empty, the function will return false. If FileName contains an invalid file path, it will error and stop the script.

File structure

[Section]
Key=Value

Example

begin
  WriteINI('Section', 'Key', 'Hello World!', LogsPath + 'Test.ini');
  WriteLn(ReadINI('Section', 'Key', LogsPath + 'Test.ini'));

  DeleteFile(LogsPath + 'Test.ini');
end.

Output:

Hello World!

See Also

• ReadINI
• DeleteINI
• INISectionExists
• INIKeyExists