Admin: 1 revision imported

2021-11-20T17:07:24Z

1 revision imported

1>Admin: /* Атрибуты и функции */

2021-08-01T11:05:40Z

‎Атрибуты и функции

Admin: 1 revision imported

2021-02-07T06:51:32Z

1 revision imported

Admin at 20:08, 12 June 2019

2019-06-12T20:08:17Z

New page

{{infobox object
|image=
|visual=
|object=Ini
|status=2
|create=[[Ini.Create|Create]]}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]}}
Объект '''ini-файл''' позволяет производить работу с внешними файлами инициализации. Файлы могут быть как в кодировке Ansi, так и в кодировке Unicode (в последнием случае, файл должен иметь корректный [[BOM]]). Каждая строка файла является либо комменатрием (начинается на знак ";"), либо указанием на ветку (представляет собой полный путь, заключенный в квардатные скобки <nowiki>[Ветка1\Ветка2...]</nowiki>), либо определением листа (в виде <nowiki>ИмяЛиста="ЗначениеЛиста"</nowiki>). Имена листьев и веток внутри одной ветки не должны быть одинаковыми. При поиске имен регистр имени не имеет значения. Листы также могут содержать бинарные данные.<br />
Пример файла инициализации, построенного указанным способом:
<pre>
;Комментарий
[Загрузки и выгрузки]
Restriction="О,К,М,Н"

;Комментарий 2
[Загрузки и выгрузки\Загрузка заявок из XLS]
Description="Загрузка из XLS"
Object="Modules\FreeForms\_ВнешниеОбработки\ЗагрузкаЗаявокXLS"

[Загрузки и выгрузки\Выгрузка на сервер]
Description="Обмен с сервером"
Object="Modules\FreeForms\_ВнешниеОбработки\ВыгрузкаНаСервер"
</pre>

== Атрибуты и функции==
{{function header}}
{{function entry
|name=[[Ini.Create|Create]]
|form={{Grey|Ini.}}'''Create'''():''<Новый объект (INI)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает новый объект типа [[Ini-файл]]
}}
{{function entry
|name=[[Ini.Clear|Clear]]
|form={{Grey|Ini.}}'''Clear'''()
|type=1
|status=2
|visual=0
|description=Функция очищает текущий ini-файл, удаляя все его ветви.
}}
{{function entry
|name=[[Ini.AddFromFile|AddFromFile]]
|form={{Grey|Ini.}}'''AddFromFile'''(''<Имя Файла (STRING)>''{{Optional|,<Пропускать ошибки (INT)>{{OptionalDefault|{{eq}}0}}}}):''<Успешно (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит загрузку из внешнего файла.
}}
{{function entry
|name=[[Ini.StoreToFile|StoreToFile]]
|form={{Grey|Ini.}}'''StoreToFile'''(''<Начальный путь (STRING)>'',''<Имя Файла>''{{Optional|,<Комментарий заголовка (STRING)>,<Юникод (INT)>{{OptionalDefault|{{eq}}1}}}}):''<Успешно (INT)>''
|type=1
|status=2
|visual=0
|description=Функция сохраняет ветку объекта во внешний файл.
}}
{{function entry
|name=[[Ini.AddFromString|AddFromString]]
|form={{Grey|Ini.}}'''AddFromString'''(''<Источник (STRING)>''):''<Успешно (INT)>''
|type=1
|status=2
|visual=0
|description=Функция производит загрузку из строки.
}}
{{function entry
|name=[[Ini.StoreToString|StoreToString]]
|form={{Grey|Ini.}}'''StoreToString'''(''<Начальный путь (STRING)>''{{Optional|,<Комментарий заголовка (STRING)>}}):''<Результат (STRING)>''
|type=1
|status=0
|visual=0
|description=Функция экспортирует ветку объекта в строку.
}}
{{function entry
|name=[[Ini.DoesExist|DoesExist]]
|form={{Grey|Ini.}}'''DoesExist'''(''<Путь (STRING)>''):''<0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет путь на существование в объекте.
}}
{{function entry
|name=[[Ini.CreateBranch|CreateBranch]]
|form={{Grey|Ini.}}'''CreateBranch'''(''<Путь (STRING)>'')
|type=1
|status=2
|visual=0
|description=Функция создает ветку по указанному пути.
}}
{{function entry
|name=[[Ini.AddLeaf|AddLeaf]]
|form={{Grey|Ini.}}'''AddLeaf'''(''<Путь (STRING)>'',''<Данные (STRING)>'')
|type=1
|status=2
|visual=0
|description=Функция создает лист по указанному пути и присваивает ему текстовое значение.
}}
{{function entry
|name=[[Ini.AddLeafBinary|AddLeafBinary]]
|form={{Grey|Ini.}}'''AddLeafBinary'''(''<Путь (STRING)>'',''<Данные (STRING,BUFFER)>'')
|type=1
|status=0
|visual=0
|description=Функция создает лист по указанному пути и присваивает ему бинарное значение.
}}
{{function entry
|name=[[Ini.DeleteBranch|DeleteBranch]]
|form={{Grey|Ini.}}'''DeleteBranch'''(''<Путь (STRING)>''{{Optional|,<Удалить саму ветку (INT)>{{OptionalDefault|{{eq}}1}}}})
|type=1
|status=2
|visual=0
|description=Функция удаляет все вложенные ветки и листья и избирательно удаляет саму ветку.
}}
{{function entry
|name=[[Ini.DeleteLeaf|DeleteLeaf]]
|form={{Grey|Ini.}}'''DeleteLeaf'''(''<Путь (STRING)>'')
|type=1
|status=2
|visual=0
|description=Функция удаляет лист по указанному пути.
}}
{{function entry
|name=[[Ini.IsBranch|IsBranch]]
|form={{Grey|Ini.}}'''IsBranch'''(''<Путь (STRING)>''):''<0 или 1 (INT)>''
|type=1
|status=2
|visual=0
|description=Функция проверяет, является ли компонент по указанному пути веткой или листом.
}}
{{function entry
|name=[[Ini.LeavesInBranch|LeavesInBranch]]
|form={{Grey|Ini.}}'''LeavesInBranch'''(''<Путь (STRING)>''):''<Количество листьев (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает количество листьев по указанному пути, либо ноль, если путь не существует.
}}
{{function entry
|name=[[Ini.ComponentsInBranch|ComponentsInBranch]]
|form={{Grey|Ini.}}'''ComponentsInBranch'''(''<Путь (STRING)>''):''<Количество листьев и веток (INT)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает количество листьев и веток по указанному пути, либо ноль, если путь не существует.
}}
{{function entry
|name=[[Ini.GetComponentByNumberName|GetComponentByNumberName]]
|form={{Grey|Ini.}}'''GetComponentByNumberName'''(''<Путь (STRING)>'',''<Индекс (INT)>''):''<Имя листа или ветки (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает имя листа (или ветки) с заданным индексом, являющегося подчиненным ветки по указанному пути.
}}
{{function entry
|name=[[Ini.GetComponentByNumberData|GetComponentByNumberData]]
|form={{Grey|Ini.}}'''GetComponentByNumberData'''(''<Путь (STRING)>'',''<Индекс (INT)>''):''<Данные листа или ветки (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает текстовые данные листа (или ветки) с заданным индексом, являющегося подчиненным ветки по указанному пути.
}}
{{function entry
|name=[[Ini.GetComponentByNumberBinaryData|GetComponentByNumberBinaryData]]
|form={{Grey|Ini.}}'''GetComponentByNumberBinaryData'''(''<Путь (STRING)>'',''<Индекс (INT)>''):''<Данные листа или ветки (BUFFER)>''
|type=1
|status=0
|visual=0
|description=Функция возвращает бинарные данные листа или ветки с заданным индексом, являющейся подчиненной ветки по указанному пути.
}}
{{function entry
|name=[[Ini.GetLeafByNumberName|GetLeafByNumberName]]
|form={{Grey|Ini.}}'''GetLeafByNumberName'''(''<Путь (STRING)>'',''<Индекс (INT)>''):''<Имя листа (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает имя листа с заданным индексом, являющегося подчиненным ветки по указанному пути.
}}
{{function entry
|name=[[Ini.GetLeafByNumberData|GetLeafByNumberData]]
|form={{Grey|Ini.}}'''GetLeafByNumberData'''(''<Путь (STRING)>'',''<Индекс (INT)>''):''<Данные листа (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает текстовые данные листа с заданным индексом, являющегося подчиненным ветки по указанному пути.
}}
{{function entry
|name=[[Ini.GetData|GetData]]
|form={{Grey|Ini.}}'''GetData'''(''<Путь (STRING)>''{{Optional|,<Данные по умолчанию (STRING)>}}):''<Данные (STRING)>''
|type=1
|status=2
|visual=0
|description=Функция возвращает текстовые данные листа или ветки по указанному пути, если лист или ветка по указанному пути отсутствует, будет возвращена строка <Данные по умолчанию>.
}}
{{function entry
|name=[[Ini.GetDataBinary|GetDataBinary]]
|form={{Grey|Ini.}}'''GetDataBinary'''(''<Путь (STRING)>''):''<Данные (BUFFER)>''
|type=1
|status=0
|visual=0
|description=Функция возвращает бинарные данные листа или ветки по указанному пути, если лист или ветка по указанному пути отсутствует, будет возвращено пустое значение.
}}
{{function footer}}

{{Объекты}}

← Older revision	Revision as of 17:07, 20 November 2021
(No difference)

@@ Line 72: / Line 72: @@
 |form={{Grey|Ini.}}'''StoreToString'''(''<Начальный путь (STRING)>''{{Optional|,<Комментарий заголовка (STRING)>}}):''<Результат (STRING)>''
 |type=1
-|status=0
+|status=2
 |visual=0
 |description=Функция экспортирует ветку объекта в строку.

← Older revision	Revision as of 06:51, 7 February 2021
(No difference)

Ini-файл - Revision history

Admin: 1 revision imported

1>Admin: /* Атрибуты и функции */

Admin: 1 revision imported

Admin at 20:08, 12 June 2019