OpenPreferences()

Syntaxe

Resultat = OpenPreferences(Fichier$ [, Options [, Encodage]])])

Ouvre un fichier de préférences.

Arguments

Fichier$	Le nom du fichier de préférences à ouvrir.
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 de signe égal. #PB_Preference_GroupSeparator: Ajoute une ligne vide entre les groupes pour faciliter la lisibilité.
Encodage (optionnel)	Permet de forcer l'utilisation d'un encodage de chaîne particulier lors de la lecture du fichier de préférences. Si une nomenclature UTF-8 (BOM) est trouvée au début du fichier, ce paramètre est ignoré et UTF-8 sera utilisé. Il peut s'agir de l'une des valeurs suivantes : #PB_UTF8 : Le fichier sera lu en UTF-8, même s'il n'a pas de nomenclature (BOM). #PB_Ascii : Le fichier sera lu en Ascii, sauf s'il existe une nomenclature UTF-8 (BOM). Si les préférences sont réécrites dans un fichier, elles utiliseront UTF-8.

Valeur de retour

Renvoie une valeur non nulle en cas de succès, zéro sinon.

Remarques

Si le fichier ne peut pas être ouvert, le programmeur peut malgré tout utiliser la commande de lecture, celle-ci renvoyant alors la valeur spécifiée par défaut. Ceci est très pratique pour initialiser en une fois les variables du programme. Les fonctions comme ReadPreferenceString() peuvent être utilisées pour lire les valeurs de préférences stockées dans le fichier.

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

Il est possible de modifier les valeurs existantes avec WritePreferenceString() ou une commande ad hoc.

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

  ; Ouvrir un fichier préférence
  OpenPreferences(#PB_Compiler_Home +"Examples/Sources/Data/test.pref")
  
  ; Examen des Groupes
  ExaminePreferenceGroups()
  ; Pour chaque groupe
  While NextPreferenceGroup()
    texte$ = texte$ + PreferenceGroupName() + #LF$ ; On récupère son nom
  ; Examen des Clés pour le groupe en cours  
    ExaminePreferenceKeys()
  ; Pour chaque clé  
  While  NextPreferenceKey()                          
    texte$ = texte$ + PreferenceKeyName() + " = " + PreferenceKeyValue() + #LF$ ; On récupère son nom et sa valeur
  Wend
  texte$ = texte$ +  #LF$
  Wend

 ; Afficher tous les groupes et toutes les clés avec leur valeur
  MessageRequester("test.pref",texte$)

  ; Fermer le fichier préférence
  ClosePreferences()    

Voir aussi

ClosePreferences()

OS Supportés

Tous