PureBasic

CreatePreferences()

Синтаксис

Result = CreatePreferences(Filename$ [, Flags])

Описание


Создаёт новый пустой файл настроек. Если файл с таким именем уже существует, он будет перезаписан новым файлом.

Параметры

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

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

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

Комментарии

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

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

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

Пример

; Создаёт файл настроек с именем Setup.ini.
CreatePreferences(GetTemporaryDirectory()+"Setup.ini")

; Создаёт группу с именем "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("Title", "PureNote") ; Title = "PureNote"

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

См. также

ClosePreferences()

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

Все

<- ClosePreferences() - Оглавление Preference - ExaminePreferenceGroups()->