File.MoveFile

From SunFlurry wiki
Jump to: navigation, search
  MoveFile (Копирование файлов)
Объект:Файл
Статус разработки: Реализована
Тип:Функция
Обращение к БД:Сервер
Исключения:Невозможно превратить в строку
Визуальность:Нет

Функция производит перемещение файла из одной папки в другую (после того, как файл будет успешно скопирован, исходный файл будет удален). Файлы могут как находиться на сервере, так и локально, возможно также скопировать файл с сервера на локальный компьютер и наоборот. Функция также используется для переименования файла (если файл источник и результат находятся в одной папке, копирования произведено не будет).

Синтаксис

File.MoveFile(<Исходный файл для перемещения (STRING)>,<Результирующий файл (STRING)>,<Заменять существующий (INT)>=1):<Файл перемещен успешно (INT)>

Аргументы

  • <Исходный файл для перемещения (STRING)> - Путь к существующему файлу. Путь может быть как серверным и так и локальным (Имена файлов).
  • <Результирующий файл (STRING)> - Путь к файлу-результату. Путь может быть как серверным и так и локальным.
  • <Заменять существующий (INT)> - (необязательный аргумент) Числовое аргумент: 1 (по умолчанию) -- если файл-результат уже существует, он будет заменен копируемым, 0 -- если файл-результат уже существует, функция не будет выполнять никаких действий и вернет 0.

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

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

Примеры

//Добавляем к имени файла префикс "done_"
File.MoveFile(Файл,GetPath(Файл)+"done_"+GetFileName(Файл),1);