====== 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 ===
- parameters - (object) paramètres
* delimiter - (char) le délimiteur à utiliser
* commentchar - (char) les caractères de commentaire
* encoding - ([[en:code:core:global#encoding|Encoding]]) l'encodage à utiliser
=== Exceptions ===
* (ParameterTypeError) type de paramètre incorrect
* (ParameterCountError) paramètre de compteur incorrect
=== 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 ===
- filename - (string) le nom du fichier à ouvrir
=== Renvoie ===
* (IniFile) cet "IniFile"
=== Exceptions ===
* (LoadFileError) ne parvient pas à charger le fichier
==== save ====
Sauvegarder un fichier.
=== Syntaxe ===
myObject.save(filename);
=== Arguments ===
- filename - (string) le nom du fichier à sauvegarder
=== Renvoie ===
* (IniFile) cet "IniFile"
=== Exceptions ===
* (SaveFileError) ne parvient pas à sauvegarder le fichier
==== clear ====
Vider un fichier.
=== Syntaxe ===
myObject.clear();
=== Renvoie===
* (IniFile) cet "IniFile"
==== preserveDeletedData ====
Conserver les données effacées sous forme de commentaires.
=== Syntaxe ===
myObject.preserveDeletedData(preserve);
=== Arguments ===
- preserve - (boolean) devrait il sauvegarder les données sous forme de commentaires ?
=== Returns ===
* (IniFile) cet "IniFile"
==== setDelimiter ====
Définit la valeur/données du délimiteur. Défaut est =.
=== Syntaxe ===
myObject.setDelimiter(delimiter);
=== Arguments ===
- delimiter - (char) le délimiteur à utiliser
=== Returns ===
* (IniFile) cet "IniFile"
==== setCommentCharacter ====
Définit le caractère de commentaire. Défaut est #.
=== Syntaxe ===
myObject.setCommentCharacter(commentchar);
=== Arguments ===
- commentchar - (char) le caractère de commentaire
=== Renvoie ===
* (IniFile) cet "IniFile"
==== setSection ====
Définit la section actuel de l'INI.
=== Syntaxe ===
myObject.setSection(sectionName);
myObject.setSection(sectionName, create);
=== Arguments ===
- sectionName - (string) le nom de la section
- create - (boolean) Créer la section si elle n'existe pas (défaut: vrai)
=== Renvoie ===
* (IniFile) cet "IniFile"
=== Exceptions ===
* (FindSectionError) ne parvient pas à trouver la section
==== setEncoding ====
Définit l'encodage à utiliser.
=== Syntaxe ===
myObject.setEncoding(encoding);
=== Arguments ===
- encoding - ([[en:code:core:global#encoding|Encoding]]) l'encodage à utiliser
=== Renvoie ===
* (IniFile) cet "IniFile"
==== sectionAt ====
Renvoie à l'index **sectionIndex** du nom de la section.
=== Syntaxe ===
myObject.sectionAt(sectionIndex);
=== Arguments ===
- sectionIndex - (integer) l'index de la section
=== Renvoie ===
* (string) l'index de la section
=== Exceptions ===
* (FindSectionError) ne parvient pas à trouver la section
==== deleteSection ====
Effacer une section.
=== Syntaxe ===
myObject.deleteSection(sectionName);
=== Arguments ===
- sectionName - (string) le nom de la section
=== Returns ===
* (IniFile) cet "IniFile"
=== Exceptions ===
* (FindSectionError) ne parvient pas à trouver la section
==== sectionCount ====
Renvoie le nombre de sections.
=== Syntaxe ===
myObject.sectionCount();
=== Renvoie ===
* (integer) le compte de section
==== keyExists ====
Renvoie vrai si une clef avec **keyName** existe.
=== Syntaxe ===
myObject.keyExists(keyName);
=== Arguments ===
- keyName - (string) le nom de la clef
=== Returns ===
* (boolean) vrai si une clef avec **keyName** existe
==== keyAt ====
Renvoie le nom de la clef se trouvant à l'index **keyIndex**.
=== Syntaxe ===
myObject.keyAt(keyIndex);
=== Arguments ===
- keyIndex - (integer) la clef de l'index
=== Renvoie ===
* (string) le nom de la clef
=== Exceptions ===
* (FindSectionError) ne parvient pas à trouver la section
==== keyValue ====
Renvoie la valeur de la clef **keyName**.
=== Syntaxe ===
myObject.keyValue(keyName);
=== Arguments ===
- keyName - (string) le nom de la clef
=== Renvoie ===
* (string) la valeur de la clef
==== setKeyValue ====
Définit la valeur de la clef **keyName**.
=== Syntaxe ===
myObject.keyValue(keyName, value);
=== Arguments ===
- keyName - (string) le nom de la clef
- value - (string) la valeur de la clef
=== Renvoie ===
* (IniFile) cet "IniFile"
==== deleteKey ====
Effacer la clef **keyName**.
=== Syntaxe ===
myObject.deleteKey(keyName);
=== Arguments ===
- keyName - (string) le nom de la clef
=== Renvoie ===
* (IniFile) cet "IniFile"
=== Exceptions ===
* (FindSectionError) ne parvient pas à trouver la section
==== keyCount ====
Renvoie le compte de clefs.
=== Syntaxe ===
myObject.keyCount();
=== Renvoie ===
* (integer) le compte de clefs