Text.Save

From SunFlurry wiki
Revision as of 11:41, 18 November 2022 by Admin (talk | contribs) (1 revision imported)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
  Save (Сохранение текста)
Объект:Текст
Статус разработки: Реализована
Тип:Функция
Обращение к БД:Сервер
Исключения:Невозможно превратить в строку, число
Визуальность:Нет

Функция сохраняет текущий файл на диск в указанной кодировке. Если кодировка не будет указана, функция сохранит текст без изменения.

Примеры кодов некоторых кириллических и прочих кодировок:

  • 0 -- ANSI (текущая системная кодировка)
  • 866 -- Кириллица OEM
  • 1200 -- UTF-16LE (стандарное многобайтовое строковое представление в системе)
  • 1201 -- UTF-16BE (стандарное многобайтовое строковое представление в системе, с переставленными местами байтами)
  • 1251 -- Кириллица Windows
  • 1252 -- Стандартная латинская кодировка Windows (латиница-1)
  • 20866 -- Кириллица KOI-8
  • 65000 -- UTF-7
  • 65001 -- UTF-8

Синтаксис

Text.Save(<Имя файла для сохранения или буфер (STRING,BUFFER)>,<Кодовая страница (INT)>=-1,<Добавить BOM (INT)>=0):<Файл сохранен успешно (INT)>

Аргументы

  • <Имя файла для сохранения или буфер (STRING,BUFFER)> - Путь к файлу. Путь может быть как серверным и так и локальным (Имена файлов). Аргумент также может содержать объект буфера, в который будет производиться сохранение (текст будет добавлен в конец буфера).
  • <Кодовая страница (INT)> - (необязательный аргумент) Кодировка, в которую необходимо перевести текст перед сохранением. Если указано число -1 (по умолчанию), текст не будет изменен перед сохранением.
  • <Добавить BOM (INT)> - (необязательный аргумент) Если этот аргумент равен 1, функция добавит в сохраняемый файл корректный BOM для кодировок UTF-16LE, UTF-16BE и UTF-8, в ином случае (по умолчанию), BOM добавлен не будет.

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

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


Примеры

Т:=Text.Create(1);
Т.AddString("<?xml version=""1.0"" encoding=""utf-8""?>");
Т.AddString("<test>Проверка</test>");
//Изменение кодировки на UTF-8, объект далее имеет признак ANSI, однако, сам текст хранится в UTF-8
Т.TranslateTo(65001);
Т.Save("C:\test.xml");