IniFile

This object allows you to read and write to a INI file.

Usable example:

var myObject= new IniFile();
myObject.load("config.ini");
myObject.setSection("SomeSettingsSection");
if (myObject.keyExists("SomeKey")){
	mytext = myObject.keyValue("SomeKey");
	newtext = mytext + "Bar";
	myObject.setKeyValue("SomeKey", newtext);
}else{
	myObject.setKeyValue("SomeKey", "Foo" );
	mytext = cfgini.keyValue("SomeKey");
}
myObject.save("config.ini");

Will result in value "Bar" being appended ever run, except first. Defaults to "Foo" if Key is unset:

Constructor function.

var myObject = new IniFile();

var myObject = new IniFile(parameters);

1. parameters - (object) parameters
   • delimiter - (char) the delimiter to use
   • commentchar - (char) the comment character
   • encoding - (Encoding) the encoding to use

• (ParameterTypeError) incorrect parameter type
• (ParameterCountError) incorrect parameter count

Create a IniFile object.

var myObject = new IniFile();

Create a IniFile object with parameters.

var myObject = new IniFile({
	delimiter: "=",
	commentCharacter: "$"
});

Loads a file.

myObject.load(filename);

1. filename - (string) the filename of the file to open

• (IniFile) this IniFile

• (LoadFileError) cannot load the file

Saves a file.

myObject.save(filename);

1. filename - (string) the filename of the file to save

• (IniFile) this IniFile

• (SaveFileError) cannot save the file

Clear the file.

myObject.clear();

• (IniFile) this IniFile

Preserve the deleted data as comments.

myObject.preserveDeletedData(preserve);

1. preserve - (boolean) should the deleted data preserved as comments

• (IniFile) this IniFile

Set the value/data delimiter. Default is =.

myObject.setDelimiter(delimiter);

1. delimiter - (char) the delimiter to use

• (IniFile) this IniFile

Set the comment character. Default is #.

myObject.setCommentCharacter(commentchar);

1. commentchar - (char) the comment character

• (IniFile) this IniFile

Sets the current INI section.

myObject.setSection(sectionName);

myObject.setSection(sectionName, create);

1. sectionName - (string) the section name
2. create - (boolean) create the section if it doesn't exists (default: true)

• (IniFile) this IniFile

• (FindSectionError) cannot find the section

Sets the encoding to use.

myObject.setEncoding(encoding);

1. encoding - (Encoding) the encoding to use

• (IniFile) this IniFile

Returns the section name at index sectionIndex.

myObject.sectionAt(sectionIndex);

1. sectionIndex - (integer) the section index

• (string) the section name

• (FindSectionError) cannot find the section

Deletes a section.

myObject.deleteSection(sectionName);

1. sectionName - (string) the section name

• (IniFile) this IniFile

• (FindSectionError) cannot find the section

Returns the number of sections.

myObject.sectionCount();

• (integer) the section count

Returns true if a key with keyName exists.

myObject.keyExists(keyName);

1. keyName - (string) the key name

• (boolean) true if a key with keyName exists

Returns the name of the key at index keyIndex.

myObject.keyAt(keyIndex);

1. keyIndex - (integer) the key index

• (string) the key name

• (KeyError) cannot find the key

Returns the value of the key keyName.

myObject.keyValue(keyName);

1. keyName - (string) the key name

• (string) the key value

• (KeyError) cannot find the key

Sets the value of the key keyName.

myObject.setKeyValue(keyName, value);

1. keyName - (string) the key name
2. value - (string) the key value

• (IniFile) this IniFile

Delete the key keyName.

myObject.deleteKey(keyName);

1. keyName - (string) the key name

• (IniFile) this IniFile

• (KeyError) cannot find the key

Returns the key count.

myObject.keyCount();

• (integer) the key count