Работа с файлами УХ

ПолучитьИмяФайла

Описание, пример вызова

///////////////////////////////////////////////////////////////////////////////
// ПРОЦЕДУРЫ И ФУНКЦИИ МЕХАНИЗМА РАБОТЫ С ФАЙЛАМИ (ХРАНИМЫМИ В КОНФИГУРАЦИИ)
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////

// Составляет полное имя файла из имени каталога и имени файла.
//
// Параметры
//  ИмяКаталога  – Строка, содержащая путь к каталогу файла на диске.
//  ИмяФайла     – Строка, содержащая имя файла, без имени каталога.
//
// Возвращаемое значение:
//   Строка – полное имя файла с учетом каталога.
//
Функция ПолучитьИмяФайла(ИмяКаталога, ИмяФайла) Экспорт

Пример вызова

Результат = РаботаСФайламиУХ.ПолучитьИмяФайла(ИмяКаталога, ИмяФайла)

ПолучитьКаталогИИмяФайла

Описание, пример вызова

// Процедура полное имя файла разбивает на путь в файлу и имя самого файла
//
// Параметры
//  ПолноеИмяФайла  – Строка, содержащая полное имя файла на диске.
//  ИмяКаталога  – Строка, содержащая путь к каталогу файла на диске.
//  ИмяФайла     – Строка, содержащая имя файла, без имени каталога.
//
Процедура ПолучитьКаталогИИмяФайла(Знач ПолноеИмяФайла, ИмяКаталога, ИмяФайла) Экспорт

Пример вызова

РаботаСФайламиУХ.ПолучитьКаталогИИмяФайла(ПолноеИмяФайла, ИмяКаталога, ИмяФайла)

УстановитьРасширениеФайла

Описание, пример вызова

// Процедура меняет расширение имени переданного файла (сам файл не меняется, меняется колько строка)
//
// Параметры
//  ИмяФайла  – Строка, содержащая полное имя файла на диске.
//  НовоеРасширениеФайла  – Строка, содержащая новое расширение файла.
//
Процедура УстановитьРасширениеФайла(ИмяФайла, Знач НовоеРасширениеФайла) Экспорт

Пример вызова

РаботаСФайламиУХ.УстановитьРасширениеФайла(ИмяФайла, НовоеРасширениеФайла)

ПолучитьДатуФайла

Описание, пример вызова

// Функция определяет дату последней модификации существующего файла на диске
// Параметры
//  ИмяФайла  – Строка, содержащая полный путь к файла на диске.
//
// Возвращаемое значение:
//   Дата – Дата последней модификации файла
//
Функция ПолучитьДатуФайла(Знач ИмяФайла) Экспорт

Пример вызова

Результат = РаботаСФайламиУХ.ПолучитьДатуФайла(ИмяФайла)

ПолучитьФильтрФайлов

Описание, пример вызова

// Формирует строку фильтра для диалога выбора файла с типами файлов.
//
// Параметры
//  Нет.
//
// Возвращаемое значение:
//   Строка – фильтр по типам файлов для диалога выбора файла.
//
Функция ПолучитьФильтрФайлов() Экспорт

Пример вызова

Результат = РаботаСФайламиУХ.ПолучитьФильтрФайлов());

ПолучитьИмяКаталога

Описание, пример вызова

// Формирует имя каталога для сохранения/чтения файлов. Для различных типов объектов возможны
// различные алгоритмы определения каталога.
//
// Параметры
//  ОбъектФайла  – Ссылка на объект данных, для которого прикрепляются файлы.
//
// Возвращаемое значение:
//   Строка – каталог файлов для указанного объекта и пользователя.
//
Функция ПолучитьИмяКаталога() Экспорт

Пример вызова

Результат = РаботаСФайламиУХ.ПолучитьИмяКаталога()

ПолучитьСписокЗапрещенныхСимволовВИменахФайлов

Описание, пример вызова

// функция возвращает список запрещенных символов в именах файлов
// Возвращаемое значение:
//   Список значений в котором хранится список всех запрещенных символов в именах файлов.
//
Функция ПолучитьСписокЗапрещенныхСимволовВИменахФайлов() Экспорт

Пример вызова

Результат = РаботаСФайламиУХ.ПолучитьСписокЗапрещенныхСимволовВИменахФайлов());

УдалитьЗапрещенныеСимволыИмени

Описание, пример вызова

// функция формирует имя файла выбрасывая из первоначально предложенного имени все
// запрещенные символы
// Параметры
//  ИмяФайла     – Строка, содержащая имя файла, без каталога.
//
// Возвращаемое значение:
//   Строка – имя файла, которое может быть использовано в файловой системе
//
Функция УдалитьЗапрещенныеСимволыИмени(Знач ИмяФайла) Экспорт

Пример вызова

Результат = РаботаСФайламиУХ.УдалитьЗапрещенныеСимволыИмени(ИмяФайла)

ПолучитьРасширениеФайла

Описание, пример вызова

// Выделяет из имени файла его расширение (набор символов после последней точки).
//
// Параметры
//  ИмяФайла     – Строка, содержащая имя файла, неважно с именем каталога или без.
//
// Возвращаемое значение:
//   Строка – расширение файла.
//
Функция ПолучитьРасширениеФайла(Знач ИмяФайла) Экспорт

Пример вызова

Результат = РаботаСФайламиУХ.ПолучитьРасширениеФайла(ИмяФайла)

ПолучитьИмяФайлаИзПолногоПути

Описание, пример вызова

// Выделяет из полного пути к файлу его имя (набор символов после последней \).
//
// Параметры
//  ПутьКФайлу     – Строка, содержащая имя файла, неважно с именем каталога или без.
//
// Возвращаемое значение:
//   Строка – расширение файла.
//
Функция ПолучитьИмяФайлаИзПолногоПути(Знач ПутьКФайлу) Экспорт

Пример вызова

Результат = РаботаСФайламиУХ.ПолучитьИмяФайлаИзПолногоПути(ПутьКФайлу)

ПолучитьЧастьСтрокиОтделеннойСимволом

Описание, пример вызова

// функция возвращает часть строки после последнего встреченного символа в строке
Функция ПолучитьЧастьСтрокиОтделеннойСимволом(Знач ИсходнаяСтрока, Знач СимволПоиска) Экспорт

Пример вызова

Результат = РаботаСФайламиУХ.ПолучитьЧастьСтрокиОтделеннойСимволом(ИсходнаяСтрока, СимволПоиска));

УдалитьФайлыАсинхронно

Описание, пример вызова

///////////////////////////////////////////////////////////////////////////////
// ФУНКЦИИ ДЛЯ ВЕБ-ПРИЛОЖЕНИЯ
///////////////////////////////////////////////////////////////////////////////

// КоличествоПопыток - 0 - удалять пока не удалятся
Функция УдалитьФайлыАсинхронно(Путь, Маска = Неопределено, КоличествоПопыток = 10) Экспорт

Пример вызова

Результат = РаботаСФайламиУХ.УдалитьФайлыАсинхронно(Путь, Маска, КоличествоПопыток);

ВыполнитьУдалениеФайлов

Описание, пример вызова

// Предполагается, что вызывается только как фоновое задание
Процедура ВыполнитьУдалениеФайлов(Путь, Маска, КоличествоПопыток, КлючЗадания) Экспорт

Пример вызова

РаботаСФайламиУХ.ВыполнитьУдалениеФайлов(Путь, Маска, КоличествоПопыток, КлючЗадания)

СкопироватьФайл

Описание, пример вызова

// Копирует файл Источник в файл Приемник с перезаписью. Если Приемник уже существует,
// то он будет перезаписан, если не существует - то создан.
// Параметры
//  Источник - Строка - Обязательный - путь к файлу, который необходимо скопировать
//  Приемник - Строка - Обязательный - путь к файлу, в который необходимо скопировать
// Возвращаемое значение
//  Истина, если копирование удалось, Ложь - иначе.
Функция СкопироватьФайл(Источник, Приемник) Экспорт

Пример вызова

Результат = РаботаСФайламиУХ.СкопироватьФайл(Источник, Приемник)

ПоместитьФайлВоВременноеХарнилище

Описание, пример вызова

// Помещает файл во временное хранилище.
// Параметры
//  ПутьКФайлу - Строка - Обязательный - путь к файлу, который необходимо поместить в хранилище
//  Адрес - Строка - Необязательный - адрес хранилища, по которому поместить файл
// Возвращаемое значение
//  Адрес хранилища, если удалось поместить файл, Неопределено - иначе.
Функция ПоместитьФайлВоВременноеХарнилище(ПутьКФайлу, Знач Адрес = Неопределено) Экспорт

Пример вызова

Результат = РаботаСФайламиУХ.ПоместитьФайлВоВременноеХарнилище(ПутьКФайлу, Адрес);