Ini.StoreToString

From SunFlurry wiki
Jump to: navigation, search
  StoreToString (Сохранение в строку)
Объект:Ini-файл
Статус разработки: Реализована
Тип:Функция
Обращение к БД:Нет
Визуальность:Нет

Функция экспортирует ветку объекта в строку.

Синтаксис

Ini.StoreToString(<Начальный путь (STRING)>,<Комментарий заголовка (STRING)>):<Результат (STRING)>

Аргументы

  • <Начальный путь (STRING)> - Путь до ветки объекта для сохранения. Имя задается в формате "Ветка1\Ветка2", при указании пустого пути, будет сохранен весь объект.
  • <Комментарий заголовка (STRING)> - (необязательный аргумент) Аргумент задает текст, добавляемый как комментарий в начало строки.

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

Возвращает UTF-16 строку.


Примеры

a:=Ini.Create();			//Новый объект
a.AddFromFile("File.ini");		//Загрузка из файла File.Ini
a.AddLeaf("Общее\Версия формата","1");	//Установка листа "Версия формата" в ветке "Общее"
Стр:=a.StoreToString("");		//Строка Стр содержит экспортированный ini-файл