Название: Тип объекта
Код: opType
Усл. видимости: нет
По умолчанию: Файл
|
Определяет тип объекта, над которым производится файловая операция.
Возможные значения:
-
Путь (path,1) – Операции со строковым представлением пути.
-
Файл (file,2) – Операции с файлами.
-
Каталог (folder,3) – Операции с каталогами.
-
Содержимое файла (content,4) – Операции с содержимым файла.
|
Название: Операция
Код: pathOps
Усл. видимости: да
По умолчанию: Тип пути
|
Операция со строковым представлением пути.
Возможные значения:
-
Тип пути (getPathType, 101) – Возвращает категорию каталога по указанному пути.
-
Относительный путь (getRelativePath, 102) – Возвращает относительный путь, вырезая из него категорию.
-
Имя файла (getFileName, 103) – Возвращает имя файла из указанного пути.
-
Расширение (getFileExtension, 104) – Возвращает расширение файла из указанного пути.
-
Каталог (getFileDirectory, 105) – Возвращает имя каталога из указанного пути.
-
Построить путь (makePath, 106) – Возвращает путь, собранный из категории каталога и относительного пути, доступный для использования в других операциях и компонентах.
-
Построить путь к файлу (makeFilePath, 107) – Возвращает путь к файлу, собранный из трех аргументов: пути, имени файла и расширения.
|
Название: Операция
Код: fileOps
Усл. видимости: да
По умолчанию: Проверить наличие
|
Операция с файлом.
Возможные значения:
-
Удалить (deleteFile, 201) – Удаляет файл.
-
Скопировать (copyFile, 202) – Копирует файл.
-
Переместить (moveFile, 203) – Перемещает файл в другой каталог.
-
Проверить наличие (fileExists, 205) – Возвращает 1, если файл существует, иначе 0.
-
Размер (getFileSize, 206) – Возвращает размер файла.
-
Хеш содержимого (getFileHash, 207) – Возвращает хеш содержимого файла.
-
Создать путь (ensureFolder, 208) – Создает каталог для файла по указанному пути, если он не существует.
-
Преобразовать в tiff (fileToFaxTiff, 209) – Преобразует файл в tiff, с параметрами подходящими для компонента Отправка факса
Поддерживаемые форматы для преобразования в tiff: bmp, jpg, pdf, png, tiff.
|
Название: Операция
Код: folderOps
Усл. видимости: да
По умолчанию: Проверить наличие
|
Операция с каталогом.
Возможные значения:
-
Создать (makeFolder, 301) – Создает каталог, если он не существует.
-
Удалить (deleteFolder, 302) – Удаляет каталог.
-
Скопировать (copyFolder, 303) – Копирует каталог со всем содержимым.
-
Переместить (moveFolder, 304) – Перемещает каталог со всем содержимым в другой каталог.
-
Проверить наличие (folderExists, 306) – Возвращает 1, если каталог существует, иначе 0.
-
Количество файлов (getFolderFileCount, 307) – Возвращает количество файлов в каталоге на первом уровне.
-
Количество подкаталогов (getFolderSubfolderCount, 308) – Возвращает количество подкаталогов на первом уровне.
|
Название: Операция
Код: contentOps
Усл. видимости: да
По умолчанию: Считать файл
|
Операция с содержимым файла.
Возможные значения:
-
Создать файл (createFile, 401) – Создает новый файл с указанным содержимым.
-
Записать файл (writeFile, 402) – Записывает новое содержимое в существующий файл.
-
Дописать в конец файла (appendFile, 403) – Добавляет содержимое в конец файла.
-
Считать файл (readFile, 404) – Возвращает содержимое файла.
Все операции с содержимым используют указанную кодировку для преобразования из строки в бинарный вид.
|
Название: Путь
Код: path
Усл. видимости: да
По умолчанию: —
|
Аргумент, содержащий путь.
|
Название: Отрезать расширение
Код: cutExtension
Усл. видимости: да
По умолчанию: Да
|
Переключатель режима возврата файла без расширения.
|
Название: Категория каталога
Код: folderType
Усл. видимости: да
По умолчанию: SYNC_COMMON
|
Категория каталога, с использованием которой путь становится доступным для применения в операциях ввода-вывода.
Возможные значения:
-
SYNC_COMMON (1) – Каталог общих данных всех доменов в синхронизирующемся между серверами каталоге.
-
SYNC_DOMAIN_COMMON (2) – Каталог общих данных домена в синхронизирующемся между серверами каталоге.
-
SYNC_DOMAIN_DATA (3) – Каталог данных домена в синхронизирующемся между серверами каталоге.
-
SYNC_SCRIPT_DATA (4) – Каталог данных сценария в синхронизирующемся между серверами.
-
SITESHARE_PUBLIC (5) – Каталог общих данных на сетевом диске сайтового хранилища, доступного всем серверам на сайте.
-
SITESHARE_DOMAIN_DATA (6) – Каталог данных домена на сетевом диске сайтового хранилища, доступного всем серверам на сайте.
-
SITESHARE_SCRIPT_DATA (7) – Каталог данных сценария на сетевом диске сайтового хранилища, доступного всем серверам на сайте.
-
GLOBALSHARE_PUBLIC (8) – Каталог общих данных на сетевом диске глобального хранилища, доступного всем сайтам.
-
GLOBALSHARE_DOMAIN_DATA (9) – Каталог данных домена на сетевом диске глобального хранилища, доступного всем сайтам.
-
GLOBALSHARE_SCRIPT_DATA (10) – Каталог данных сценария на сетевом диске глобального хранилища, доступного всем сайтам.
-
TEMP (11) – Временный каталог текущего обработчика сценария. Удаляется через 5 секунд после его завершения.
|
Название: Относительный путь
Код: tail
Усл. видимости: да
По умолчанию: —
|
Аргумент, содержащий относительный путь.
|
Название: Имя файла
Код: fileName
Усл. видимости: да
По умолчанию: —
|
Аргумент, содержащий название файла.
|
Название: Расширение
Код: fileExtension
Усл. видимости: да
По умолчанию: —
|
Аргумент, содержащий расширение файла.
|
Название: Путь источника
Код: sourcePath
Усл. видимости: да
По умолчанию: —
|
Аргумент, содержащий путь источника.
|
Название: Путь назначения
Код: destinationPath
Усл. видимости: да
По умолчанию: —
|
Аргумент, содержащий путь назначения.
|
Название: Хеш-функция
Код: hashFunction
Усл. видимости: да
По умолчанию: MD5
|
Хеш-функция для применения к содержимому файла.
|
Название: Содержимое
Код: fileData
Усл. видимости: да
По умолчанию: —
|
Аргумент с содержимым файла.
|
Название: Кодировка
Код: encodingType
Усл. видимости: да
По умолчанию: Авто
|
Кодировка для применения к содержимому файла при считывании в переменную и наоборот.
Возможные значения:
-
Авто (1) – Автоматическое определение.
-
Бинарные данные (binary, 2) – Считывание бинарных данных без преобразования.
-
utf-8 (3)
-
utf-16 (4)
-
utf-32 (5)
-
cp1251 (6) – Кодовая страница windows-1251 (кириллица).
-
Указать название (byname, 7) – Указание имени кодировки.
|
Название: BOM
Код: utfBOM
Усл. видимости: да
По умолчанию: С BOM
|
Режим считывания содержания файла с учетом префикса кодировки для UTF.
Возможные варианты:
-
С BOM (withBOM, 1).
-
Без BOM (withoutBOM, 2).
|
Название: Endian
Код: utfEndian
Усл. видимости: да
По умолчанию: Little-Endian
|
Режим раскладки кодировки unicode.
Возможные варианты:
-
Little-Endian (littleEndian, 1).
-
Big-Endian (bigEndian, 2).
|
Название: Название кодировки
Код: encodingName
Усл. видимости: да
По умолчанию: "cp1251"
|
Аргумент, содержащий имя применяемой кодировки.
|
Название: Результат в переменную
Код: result
Усл. видимости: нет
По умолчанию: —
|
Переменная для сохранения результата операции.
|
Название: Код ошибки в переменную
Код: errorReason
Усл. видимости: нет
По умолчанию: —
|
Переменная для сохранения кода ошибки операции.
|
Название: Переход
Код: transfer
Усл. видимости: нет
По умолчанию: —
|
Компонент, которому передается управление в случае успешного завершения операции.
|
Название: Переход, не найдено
Код: transferNotFound
Усл. видимости: да
По умолчанию: —
|
Компонент, которому передается управление в случае, если объект по указанному пути отсутствует.
|
Название: Переход, ошибка
Код: transferError
Усл. видимости: нет
По умолчанию: —
|
Компонент, которому передается управление в случае ошибки выполнения операции.
|
