Difference between revisions of "Ini.StoreToFile"
m (1 revision imported) |
|||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 21: | Line 21: | ||
* <code>''<Начальный путь (STRING)>''</code> - Путь до ветки объекта для сохранения. Имя задается в формате '''"Ветка1\Ветка2"''', при указании пустого пути, будет сохранен весь объект. | * <code>''<Начальный путь (STRING)>''</code> - Путь до ветки объекта для сохранения. Имя задается в формате '''"Ветка1\Ветка2"''', при указании пустого пути, будет сохранен весь объект. | ||
* <code>''<Имя Файла (STRING)>''</code> - Имя файла для сохранения в [[Имена файлов|нотации системы]]. | * <code>''<Имя Файла (STRING)>''</code> - Имя файла для сохранения в [[Имена файлов|нотации системы]]. | ||
| − | * <code>''<Юникод (INT)>''{{Default|{{eq}}1}}</code> - {{optional}} Возможные значения -- 1 или 0. В режиме 1 файл будет сохранен в формате UTF-16, иначе в кодировке Ansi (для преобразования в другие форматы, используйте функцию '''[[Ini.StoreToString|StoreToString]]'''. | + | * <code>''<Комментарий заголовка (STRING)>''</code> - {{Optional}} Аргумент задает текст, добавляемый как комментарий в начало файла. |
| + | * <code>''<Юникод (INT)>''{{Default|{{eq}}1}}</code> - {{optional}} Возможные значения -- 1 или 0. В режиме 1 файл будет сохранен в формате UTF-16, иначе в кодировке Ansi (для преобразования в другие форматы, используйте функцию '''[[Ini.StoreToString|StoreToString]]'''). | ||
==== Возвращаемое значение ==== | ==== Возвращаемое значение ==== | ||
Возвращает 1, если файл успешно сохранен, иначе 0. | Возвращает 1, если файл успешно сохранен, иначе 0. | ||
Latest revision as of 18:07, 20 November 2021
| StoreToFile (Сохранение в файл) | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
Функция сохраняет ветку объекта во внешний файл.
Синтаксис
Ini.StoreToFile(<Начальный путь (STRING)>,<Имя Файла>,<Комментарий заголовка (STRING)>,<Юникод (INT)>=1):<Успешно (INT)>
Аргументы
<Начальный путь (STRING)>- Путь до ветки объекта для сохранения. Имя задается в формате "Ветка1\Ветка2", при указании пустого пути, будет сохранен весь объект.<Имя Файла (STRING)>- Имя файла для сохранения в нотации системы.<Комментарий заголовка (STRING)>- (необязательный аргумент) Аргумент задает текст, добавляемый как комментарий в начало файла.<Юникод (INT)>=1- (необязательный аргумент) Возможные значения -- 1 или 0. В режиме 1 файл будет сохранен в формате UTF-16, иначе в кодировке Ansi (для преобразования в другие форматы, используйте функцию StoreToString).
Возвращаемое значение
Возвращает 1, если файл успешно сохранен, иначе 0.
Примеры
a:=Ini.Create(); //Новый объект
a.AddFromFile("File.ini"); //Загрузка из файла File.Ini
a.AddLeaf("Общее\Версия формата","1"); //Установка листа "Версия формата" в ветке "Общее"
a.StoreToFile("","File.ini"); //Сохранение в файл File.Ini
