Table of Contents

IniFile

Cet objet vous permet de lire et écrire sur un fichier INI.

Fonctions

IniFile

Fonction de construction.

Syntaxe

var myObject = new IniFile();
var myObject = new IniFile(parameters);

Arguments

  1. parameters - (object) paramètres
    • delimiter - (char) le délimiteur à utiliser
    • commentchar - (char) les caractères de commentaire
    • encoding - (Encoding) l'encodage à utiliser

Exceptions

Exemple

Créer un objet "IniFile" (fichier INI).

var myObject = new IniFile();

Créer un objet "IniFile" avec paramètres.

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

Méthodes

load

Charger un fichier.

Syntaxe

myObject.load(filename);

Arguments

  1. filename - (string) le nom du fichier à ouvrir

Renvoie

Exceptions

save

Sauvegarder un fichier.

Syntaxe

myObject.save(filename);

Arguments

  1. filename - (string) le nom du fichier à sauvegarder

Renvoie

Exceptions

clear

Vider un fichier.

Syntaxe

myObject.clear();

Renvoie

preserveDeletedData

Conserver les données effacées sous forme de commentaires.

Syntaxe

myObject.preserveDeletedData(preserve);

Arguments

  1. preserve - (boolean) devrait il sauvegarder les données sous forme de commentaires ?

Returns

setDelimiter

Définit la valeur/données du délimiteur. Défaut est =.

Syntaxe

myObject.setDelimiter(delimiter);

Arguments

  1. delimiter - (char) le délimiteur à utiliser

Returns

setCommentCharacter

Définit le caractère de commentaire. Défaut est #.

Syntaxe

myObject.setCommentCharacter(commentchar);

Arguments

  1. commentchar - (char) le caractère de commentaire

Renvoie

setSection

Définit la section actuel de l'INI.

Syntaxe

myObject.setSection(sectionName);
myObject.setSection(sectionName, create);

Arguments

  1. sectionName - (string) le nom de la section
  2. create - (boolean) Créer la section si elle n'existe pas (défaut: vrai)

Renvoie

Exceptions

setEncoding

Définit l'encodage à utiliser.

Syntaxe

myObject.setEncoding(encoding);

Arguments

  1. encoding - (Encoding) l'encodage à utiliser

Renvoie

sectionAt

Renvoie à l'index sectionIndex du nom de la section.

Syntaxe

myObject.sectionAt(sectionIndex);

Arguments

  1. sectionIndex - (integer) l'index de la section

Renvoie

Exceptions

deleteSection

Effacer une section.

Syntaxe

myObject.deleteSection(sectionName);

Arguments

  1. sectionName - (string) le nom de la section

Returns

Exceptions

sectionCount

Renvoie le nombre de sections.

Syntaxe

myObject.sectionCount();

Renvoie

keyExists

Renvoie vrai si une clef avec keyName existe.

Syntaxe

myObject.keyExists(keyName);

Arguments

  1. keyName - (string) le nom de la clef

Returns

keyAt

Renvoie le nom de la clef se trouvant à l'index keyIndex.

Syntaxe

myObject.keyAt(keyIndex);

Arguments

  1. keyIndex - (integer) la clef de l'index

Renvoie

Exceptions

keyValue

Renvoie la valeur de la clef keyName.

Syntaxe

myObject.keyValue(keyName);

Arguments

  1. keyName - (string) le nom de la clef

Renvoie

setKeyValue

Définit la valeur de la clef keyName.

Syntaxe

myObject.keyValue(keyName, value);

Arguments

  1. keyName - (string) le nom de la clef
  2. value - (string) la valeur de la clef

Renvoie

deleteKey

Effacer la clef keyName.

Syntaxe

myObject.deleteKey(keyName);

Arguments

  1. keyName - (string) le nom de la clef

Renvoie

Exceptions

keyCount

Renvoie le compte de clefs.

Syntaxe

myObject.keyCount();

Renvoie