Difference between revisions of "File.MoveFile"

From SunFlurry wiki
Jump to: navigation, search
m (1 revision imported)
1>Admin
Line 17: Line 17:
 
== Синтаксис ==
 
== Синтаксис ==
 
<code>
 
<code>
{{Grey|File.}}'''MoveFile'''(''<Исходный файл для перемещения (STRING)>'',''<Результирующий файл (STRING)>''{{Optional|,<Заменять существующий (INT)>{{Default|{{eq}}1}}}}):''<Файл перемещен успешно (INT)>''
+
{{Grey|File.}}'''MoveFile'''(''<Исходный файл для перемещения (STRING)>'',''<Результирующий файл (STRING)>''{{Optional|,<Не заменять существующий (INT)>{{Default|{{eq}}0}}}}):''<Файл перемещен успешно (INT)>''
 
</code>
 
</code>
  
Line 23: Line 23:
 
* <code>''<Исходный файл для перемещения (STRING)>''</code> - Путь к существующему файлу. Путь может быть как серверным и так и локальным ([[Имена файлов]]).
 
* <code>''<Исходный файл для перемещения (STRING)>''</code> - Путь к существующему файлу. Путь может быть как серверным и так и локальным ([[Имена файлов]]).
 
* <code>''<Результирующий файл (STRING)>''</code> - Путь к файлу-результату. Путь может быть как серверным и так и локальным.
 
* <code>''<Результирующий файл (STRING)>''</code> - Путь к файлу-результату. Путь может быть как серверным и так и локальным.
* <code>''<Заменять существующий (INT)>''</code> - {{Optional}} Числовое аргумент: 1 (по умолчанию) -- если файл-результат уже существует, он будет заменен копируемым, 0 -- если файл-результат уже существует, функция не будет выполнять никаких действий и вернет 0.
+
* <code>''<Не заменять существующий (INT)>''</code> - {{Optional}} Числовое аргумент: 0 (по умолчанию) -- если файл-результат уже существует, он будет заменен копируемым, 1 -- если файл-результат уже существует, функция не будет выполнять никаких действий и вернет 0.
  
 
==== Возвращаемое значение ====
 
==== Возвращаемое значение ====

Revision as of 10:22, 16 May 2025

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

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

Синтаксис

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

Аргументы

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

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

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

Примеры

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