Inifile

From Base de connaissances eggdrops & TCL
Jump to: navigation, search

Inifile - Analyse des fichiers INI de Windows

Syntaxe

package require Tcl 8.2
package require inifile ?0.2.3?
::ini::open file ?access?
::ini::close ini
::ini::commit ini
::ini::revert ini
::ini::filename ini
::ini::sections ini
::ini::keys ini section
::ini::get ini section
::ini::exists ini section  ? key ? 
::ini::value ini section key  ? default ? 
::ini::set ini section key value
::ini::delete ini section  ? key ? 
::ini::comment ini section  ? key ?   ? text ? 
::ini::commentchar  ? char ?

Description

Ce paquet fournit une interface pour la manipulation des fichiers INI Windows.

  • ::ini::open file ?access? : Ouvre un fichier INI et retourne le canal utilisable par les autres commandes. access est de la même forme que pour open à la différence que le mode a n'existe pas. L'accès par défaut est r+.
  • ::ini::close $ini : Ferme le canal spécifié. Si des modifications ont été faites mais pas commitées, elles sont perdues.
  • ::ini::commit $ini : Réécrit le fichier et tous les changements. Les sections sont écrites dans un ordre arbitraire, les clés d'une sections sont écrites dans l'ordre alphabétique. Si le fichier a été ouvert en lecture seulement, une erreur est générée.
  • ::ini::revert $ini : Annule tous les changements depuis le dernier commit.
  • ::ini::filename $ini : Retourne le nom du fichier associé au canal.
  • ::ini::sections $ini : Retourne la liste de toutes les sections présentes dans le fichier ini spécifié.
  • ::ini::keys $ini section : Retourne la liste de toutes les clés associées à la section du fichier ini spécifié.
  • ::ini::get $ini section : retourne la liste de paires "clé => valeur" qui existent dans la section du fichier ini spécifié.
  • ::ini::exists $ini section ?key? : Retourne une valeur booléenne indiquant l'existence de la section spécifiée ou la clé spécifiée dans cette section
  • ::ini::value $ini section key ?default? : Retourne la valeur de la clé spécifiée dans la section. Si la clé n'existe pas et qu'une valeur par défaut est indiquée, cette valeur est retournée.
  • ::ini::set $ini section key value : Assigne la valeur à la clé de la section spécifiée. La section est créée si elle n'existe pas.
  • ::ini::delete $ini section ?key? : Supprime la clé ou la section et toutes ses clés. Une section n'est pas supprimée automatiquement lorsqu'elle est vide.
  • ::ini::comment $ini section ?key? ?text? : Lit et modifie les commentaires d'une section ou d'une clé d'une section.
    • Pour écrire un commentaire de section, key doit être une chaîne vide.
    • Pour retirer uncommentaire, text doit être une chaine vide.
    • Le texte est sous la form d'une liste de ligne ou bien d'une seule ligne.
    • La lecture du commentaire d'une section inexistante ou d'une clé inexistante retourne une chaine vide.
  • ::ini::commentchar ?char? : Lit et assigne le caractère de commentaire. Les lignes commençant par ce caractère sont considérées comme des commentaires. La valeur par défaut est ;

Utilisation

Voir Utilisation d'inifile

Voir aussi