OpenPreferences()

Syntax

Ergebnis = OpenPreferences(Dateiname$ [, Flags] [, Kodierung]])
Beschreibung
Öffnet eine bereits existierende Preference-Datei.

Parameter

Dateiname$ Der Dateiname der Preference-Datei.
Flags (optional) Dies kann eine Kombination der folgenden Werte sein: 
  #PB_Preference_NoSpace: es werden keine Leerzeichen rings um das Gleichheitszeichen (=) - zwischen
                          Schlüssel und Wert - eingefügt,
                          Dies kann nützlich beim Umgang mit externen Voreinstellungs-Dateien
                          sein, welche kein Leerzeichen rings um das Leerzeichen akzeptieren.
  #PB_Preference_GroupSeparator: fügt eine leere Zeile zwischen den Gruppen ein, um die
                                 Lesbarkeit der Datei zu erhöhen.
Kodierung (optional) Um eine String-Kodierung beim Lesen der Preference-Datei zu erzwingen. Wenn am Anfang der Datei ein UTF-8-BOM gefunden wird, wird dieser Parameter ignoriert und UTF-8 verwendet. Es kann einer der folgenden Werte sein: 
  #PB_UTF8: Die Datei wird als UTF-8 gelesen, auch wenn sie kein BOM hat.
  #PB_Ascii: Die Datei wird als ASCII gelesen, es sei denn, es gibt ein UTF-8-BOM. Wenn die
             Einstellungen in die Datei zurückgeschrieben werden, wird UTF-8 verwendet.

Rückgabewert

Gibt einen Wert ungleich Null zurück, wenn die Datei erfolgreich geöffnet wurde, andernfalls Null.

Anmerkungen

Wenn auch die Datei nicht gefunden oder geöffnet werden konnte, ist es trotzdem möglich, die Lese-Funtionen zu nutzen, die dann jeweils die angegebenen Standardwerte zurückgeben. Dies ist sehr nützlich, um in einem Schritt die Programmvariablen zu initialisieren. Die Befehle wie ReadPreferenceString() können zum Lesen der in der Datei gespeicherten Voreinstellungswerte genutzt werden.

Zum Entfernen eines Schlüssels oder einer Gruppe sind die Befehle RemovePreferenceKey() und RemovePreferenceGroup() verfügbar. Zum Erstellen oder Ändern einer Gruppe verwenden Sie PreferenceGroup().

Es ist möglich, existierende Werte mittels WritePreferenceString() und ähnlichen Befehlen zu ändern.

Sobald alle Schreib-Operationen erfolgt sind, muss ClosePreferences() aufgerufen werden, damit die Voreinstellungen tatsächlich auf Disk geschrieben werden (sofern sie in der Zwischenzeit verändert wurden).

Beispiel

  ; Öffnet eine Preference-Datei
  OpenPreferences(#PB_Compiler_Home +"examples/sources/Data/test.pref")
  
  ; Gruppen untersuchen
  ExaminePreferenceGroups()
  ; Für jede Gruppe
  While NextPreferenceGroup()
    text$ = text$ + PreferenceGroupName() + #LF$ ; deren Name
    ; Schlüssel der aktuellen Gruppe untersuchen
    ExaminePreferenceKeys()
    ; Für jeden Schlüssel
    While  NextPreferenceKey()                          
      text$ = text$ + PreferenceKeyName() + " = " + PreferenceKeyValue() + #LF$ ; dessen Name und seine Daten
    Wend
    text$ = text$ + #LF$
  Wend

  ; Anzeigen aller Gruppen und aller Schlüssel mit Daten
  MessageRequester("test.pref", text$)

  ; Schließt die Preference-Datei
  ClosePreferences()

Siehe auch

ClosePreferences()

Unterstützte OS

Alle

<- NextPreferenceKey() - Preference Inhaltsverzeichnis - PreferenceComment() ->