CreatePreferences()

Syntaxe

Resultat = CreatePreferences(Fichier$ [, Options])
Description
Crée un nouveau fichier de préférences vide.
Si le fichier existe déjà, il est écrasé.

Arguments

Fichier$ Le nom du nouveau fichier de préférences.
Options (optionnel) Peut être une combinaison des valeurs suivantes:
  #PB_Preference_NoSpace       : Pas d'espaces autour du signe égal.
                                 Utile quand il s'agit d'un fichier de préférences externes qui 
                                 n'accepte pas les espaces autour du signe égal.
  #PB_Preference_GroupSeparator: Ajoute une ligne vide entre les groupes pour faciliter la lisibilité.

Valeur de retour

Renvoie une valeur non nulle si le fichier a été créé avec succès, zéro sinon.

Remarques

Une fois le fichier créé, les commandes telles que WritePreferenceString() par exemple permettent d'écrire des informations dedans. Une fois les valeurs écrites, il est possible de les relire avec ReadPreferenceString() ou une commande ad hoc.

Pour effacer une clé ou un groupe, utiliser RemovePreferenceKey() ou RemovePreferenceGroup().
PreferenceGroup() permet de créer ou changer le groupe courant.

Une fois les opérations sur le fichier terminées, il faut utiliser ClosePreferences() pour mettre à jour, écrire et fermer le fichier préférences sur le disque.

Exemple

  ; Créer un fichier preference nommé Setup.ini
  CreatePreferences(GetTemporaryDirectory()+"Setup.ini")
  
  ; Créer un groupe nommé "Window"
  PreferenceGroup("Window")
    WritePreferenceLong ("X", 10)     ; X = 10
    WritePreferenceLong ("Y", 10)     ; Y = 10
    WritePreferenceLong("W", 800)     ; W = 800
    WritePreferenceLong("H", 600)     ; H = 600
    WritePreferenceFloat("%", 20)     ; % = 20.000000
    WritePreferenceString("Titre", "PureNote") ; Titre = "PureNote"
  
  ; Fermer le fichier préférence
  ClosePreferences()

Voir aussi

ClosePreferences()

OS Supportés

Tous

<- ClosePreferences() - Preference Index - ExaminePreferenceGroups() ->