Файл

File (Файл)
Статус разработки: Реализован Создание объекта: Create

• Начальная страница
• Общее описание
• Объекты

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

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

Идентификатор	Статус	Тип	Визуальная	Параметры	Описание
Create	Реализована	Функция		File.Create():<Новый объект (FILE)>	Функция возвращает новый объект типа Файл
DoesFileExist	Реализована	Функция		File.DoesFileExist(<Имя файла для проверки (STRING)>):<Существует ли указанный файл (INT)>	Функция проверяет наличие файла на локальном компьютере или сервере.
DoesPathExist	Реализована	Функция		File.DoesPathExist(<Путь для проверки (STRING)>):<Существует ли указанный путь (INT)>	Функция проверяет существование пути на локальном компьютере или сервере.
CopyFile	Реализована	Функция		File.CopyFile(<Исходный файл для копирования (STRING)>,<Результирующий файл (STRING)>,<Заменять существующий (INT)>=1):<Файл скопирован успешно (INT)>	Функция производит копирование файла из одной папки в другую. Файлы могут как находиться на сервере, так и локально, возможно также скопировать файл с сервера на локальный компьютер и наоборот.
DeleteFile	Реализована	Функция		File.DeleteFile(<Файл для удаления (STRING)>):<Файл удален успешно (INT)>	Функция производит попытку удаления указанного файла.
MoveFile	Реализована	Функция		File.MoveFile(<Исходный файл для перемещения (STRING)>,<Результирующий файл (STRING)>,<Заменять существующий (INT)>=1):<Файл перемещен успешно (INT)>	Функция производит перемещение файла из одной папки в другую. Файлы могут как находиться на сервере, так и локально, возможно также скопировать файл с сервера на локальный компьютер и наоборот.
FindOpen	Реализована	Функция		File.FindOpen(<Путь и маска для выборки файлов (STRING)>)	Функция открывает выборку файлов с указанным путем и маской. Выборка может происходить как локально, так и не сервере. Предыдущая выборка текущего объекта или потока (если обращение происходит с помощью интерфейса) будет автоматически закрыта.
FindNextFile	Реализована	Функция		File.FindNextFile():<Имя следующего найденного файла выборки (STRING)>	Функция получить следующий файл выборки, открытой ранее с помощью функции FindOpen. Если файлов в выборке больше нет, функция возвращает пустую строку. После выполнения функции, имя файла можно получить снова с помощью атрибута FileName.
FileName	Реализована	Атрибут		File.FileName:<Имя файла выборки файлов (STRING)>	Получить имя файла в процессе выборки файлов с помощью функций FindOpen и FindNextFile.
LoadFileNames	Реализована	Функция		File.LoadFileNames(<Путь и маска для выборки файлов (STRING)>,<Включать вложенные папки (INT)>=0):<Список с файлами выборки (LIST)>	Функция получает список файлов выборки с указанным путем и маской. Функция используется как альтернатива функциям FindOpen и FindNextFile. Однако, для очень больших выборок, она может выполняться долгое время, тогда как FindNextFile получает информацию порциями, что может быть выгоднее для индикации процесса работы.
LoadFiles	Реализована	Функция		File.LoadFiles(<Путь и маска для выборки файлов (STRING)>,<Тип отдаваемых объектов (INT)>=0,<Включать вложенные папки (INT)>=0):<Список с содержимым файлов выборки (LIST)>	Функция осуществляет загрузку найденных с помощью выборки файлов, и отдается содержимое загруженных файлов в списке. Так как функция выполняется за один запрос к серверу (если файлы находятся на сервере), ее можно использовать, как функцию оптимизации при работе с клиентами, подключенными через медленные соединения (к примеру, через Интернет).
GetFileAttributes	Реализована	Функция		File.GetFileAttributes(<Путь и имя файла или папки (STRING)>):<Атрибуты файла или папки (INT)>	Функция возвращает системные атрибуты файла или папки, путь к которым задается первым аргументом. Если файл или папка не существуют, функция возвращает -1.
IsDirectory	Реализована	Функция		File.IsDirectory(<Путь и имя файла или папки (STRING)>):<Является ли путь папкой (1) или файлом (0) (INT)>	Функция поверяет, является ли указанный путь папкой или файлом. Если путь не существует, функция возвращает -1.
GetFileSize	Реализована	Функция		File.GetFileSize(<Путь и имя файла (STRING)>):<Размер файла в байтах (INT)>	Функция возвращает размер указанного файла в байтах.
GetFileTimes	Реализована	Функция		File.GetFileTimes(<Путь и имя файла (STRING)>,<Время создания файла (DATE)>,<Время последнего доступа к файлу (DATE)>,<Время последней записи файла (DATE)>):<Файл существует и доступен (INT)>	Функция получает время создания, изменения или доступа к файлу или папке.
SetFileTimes	Реализована	Функция		File.SetFileTimes(<Путь и имя файла (STRING)>,<Время создания файла (DATE)>=-1,<Время последнего доступа к файлу (DATE)>=-1,<Время последней записи файла (DATE)>=-1):<Время успешно установлено (INT)>	Функция устанавливает время создания, изменения или доступа для файла или папки. Любой из аргументов установки времени может быть опущен, в этом случае соответствующее время не будет изменено.
CreateDirectory	Реализована	Функция		File.CreateDirectory(<Путь и имя папки (STRING)>):<Успешно (1) или ошибка (0) (INT)>	Функция создает путь до указанной папки. Любые промежуточные папки пути, если не существовали, также будут созданы. Если папка создана удачно или уже существовала до вызова функции, функция вернет 1. Если какую-либо из папок пути создать не удалось, функция вернет 0.
RemoveDirectory	Реализована	Функция		File.RemoveDirectory(<Путь и имя папки (STRING)>):<Успешно (1) или ошибка (0) (INT)>	Функция удаляет последнюю папку пути, если удаление удачно, функция возвратит 1, иначе 0.
SetCurrentDirectory	Реализована	Функция		File.SetCurrentDirectory(<Путь и имя папки (STRING)>):<Успешно (1) или ошибка (0) (INT)>	Функция устанавливает системную текущую локальную папку, которая может быть использована расширениями программы.
GetCurrentDirectory	Реализована	Функция		File.GetCurrentDirectory():<Текущая локальная папка (STRING)	Функция получает системную текущую локальную папку, которая может быть использована расширениями программы.
ComputeFastCRC	Реализована	Функция		File.ComputeFastCRC(<Путь и имя файла (STRING)>):<Результат-контрольная сумма (INT)>	Функция подсчитывает быструю внутреннюю (небезопасную) контрольную сумму файла. См. также CalculateHash (INTERNAL).
DeleteFiles	Планируется	Функция		File.DeleteFiles(<Путь и маска файлов (STRING)>):<Успешно (1) или ошибка (0) (INT)>	Функция производит удаление файлов в указанной папке по заданной маске.