OpenPreferences()

Синтаксис

Result = OpenPreferences(Filename$ [, Flags])

Описание

Открывает существующий файл настроек.

Параметры

Filename$	Имя файла используемое для хранения на диске файла настроек.
Flags (дополн.)	Этот параметр может быть комбинацией следующих значение (с помощью оператора '|'): #PB_Preference_NoSpace: Не будет пробелов между "ключом", знаком "=" и "значением". Это может быть полезно при работе с файлами внешних настроек, которые не принимают пробелы рядом со знаком равенства. #PB_Preference_GroupSeparator: Добавляет пустую строку между группами, чтобы облегчить читаемость файла.

Возвращаемое значение

Возвращает не нулевое значение, если файл был открыт успешно, в противном случае 0.

Комментарии

Даже если файл не был найден или не может быть открыт, программист всё же может использовать функции чтения, которые будут возвращать заданные значения по умолчанию, очень полезно для пошаговой инициализации переменных программы. Прочитать значения настроек, сохранённые в файле можно с помощью функций вроде ReadPreferenceString().

Для удаления ключа или группы есть функции RemovePreferenceKey() и RemovePreferenceGroup(). Чтобы создать или изменить текущую группу, воспользуйтесь функцией PreferenceGroup().

Можно изменять существующие значения с помощью функции WritePreferenceString() и ей подобным.

Когда все операции выполнены, для принудительной записи файла обратно на диск используется функция ClosePreferences() (если файл был изменён).

Пример

; Открывает файл настроек
OpenPreferences(#PB_Compiler_Home +"Examples\Sources\Data\test.pref")

; Исследует группы
ExaminePreferenceGroups()
; Для каждой группы
While NextPreferenceGroup()
    texte$ = texte$ + PreferenceGroupName() + #LF$ ; её имя
                                                  ; Исследует ключи для текущей группы
    ExaminePreferenceKeys()
    ; Для каждого ключа
    While  NextPreferenceKey()
        texte$ = texte$ + PreferenceKeyName() + " = " + PreferenceKeyValue() + #LF$ ; его название и его данные
    Wend
    texte$ = texte$ +  #LF$
Wend

; Отображение всех групп и всех ключей с данными
MessageRequester("test.pref", texte$)

; Закрывает файл настроек
ClosePreferences()

См. также

ClosePreferences()

Поддерживаемые OS

Все