Alpha.Community

В разделе Документация вы найдете все для уверенного старта и работы с Альфа платформой: от пошаговых инструкций по установке и конфигурированию до подробного описания работы компонентов и подсистем. Для поиска необходимых тем и вопросов в документации, воспользуйтесь поиском и фильтрацией результатов.

Функции

Exists

Определяет существование файла или папки.

Синтаксис

bool Exists(string Path)

Параметры

Параметр Тип Описание
Path string Относительный путь до папки или файла относительно значения свойства Корневой путь компонента. Допускается использование прямых (/) или обратных (\\) слешей. При использовании обратных слешей они должны быть экранированы.

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

true Возвращается в случае, если файл (или папка) с заданным в параметре Path существует.
false Возвращается в случае, если файл (или папка) с заданным в параметре Path не существует.

Примеры

Если по указанному пути файл существует, вывести в поле ввода: Файл существует.

if (FileSystem.Exists("Work/Test/log.txt"))
{
  TextEdit.Text = "Файл существует";
};

CombinePath

Объединяет указанные текстовые пути в единый путь. Позволяет облегчить формирование составных путей. Первый параметр leftпредставляет основной путь, а второй параметр right представляет дополнительный путь до папки или текстового файла.

Все пути указываются в двойных кавычках. При передаче пути необходимо учесть, что обратные слеши должны быть экранированы (например, C:\\project\\file.txt). Также можно использовать прямые слеши без экранирования (например, C:/project/file.txt).

Синтаксис

string CombinePath(string left, string right)

Параметры

Параметр Тип Описание
left string Текстовый путь 1.
right string Текстовый путь 2.

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

Возвращает строку, представляющую объединенный путь.

Примеры

Объединить указанные пути и записать в поле ввода. Результат слияния - строка: C:\Users\пользователь\TestFolder\TestFile.txt.

TextEdit.Text = FileSystem.CombinePath("C:\\Users\\пользователь", "\\TestFolder\\TestFile.txt");

CreateRecursiveFolder

Создает папку по указанному пути.

Синтаксис

void CreateRecursiveFolder(string folderPath)

Параметры

Параметр Тип Описание
folderPath string Относительный путь к создаваемой папке относительно значения свойства Корневой путь компонента. Допускается использование прямых (/) или обратных (\\) слешей. При использовании обратных слешей они должны быть экранированы.

Примеры

Создать папку.

FileSystem.CreateRecursiveFolder("Work/Test/");

RemoveRecursive

Удаляет папку, включая все файлы и подпапки внутри неё. Используется также для удаления отдельного файла по указанному пути.

Синтаксис

void RemoveRecursive(string sourcePath)

Параметры

Параметр Тип Описание
sourcePath string Относительный путь до папки или файла относительно значения свойства Корневой путь компонента. Допускается использование прямых (/) или обратных (\\) слешей. При использовании обратных слешей они должны быть экранированы.

Примеры

Удалить папку Work внутри корневого пути компонента.

FileSystem.RemoveRecursive("Work");

Удалить вложенную папку и всё её содержимое.

FileSystem.RemoveRecursive("Work/Test");

ReadTextFile

Метод устарел.

Предоставляет содержимое текстового файла для чтения. Содержимое файла должно быть в кодировке UTF-8.

Синтаксис

string ReadTextFile(string FilePath)

Параметры

Параметр Тип Описание
FilePath string Относительный путь до текстового файла относительно значения свойства Корневой путь компонента. Допускается использование прямых (/) или обратных (\\) слешей. При использовании обратных слешей они должны быть экранированы.

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

Возвращает строку с содержимым текстового файла.

Примеры

Содержимое файла поместить в текстовое поле. В параметре FilePath указать путь до текстового файла.

TextEdit.Text = FileSystem.ReadTextFile("Work/Test/log.txt");

AppendTextFile

Метод устарел.

Записывает строку текста в конец текстового файла (*.txt , *.xml , *.json и другие любые текстовые форматы).

Синтаксис

void AppendTextFile(string filePath, string content)

Параметры

Параметр Тип Описание
FilePath string Относительный путь до текстового файла относительно значения свойства Корневой путь компонента. Допускается использование прямых (/) или обратных (\\) слешей. При использовании обратных слешей они должны быть экранированы.
Content string Текстовая строка.

Примеры

Записать строку текста в файл по указанному пути.

FileSystem_1.AppendTextFile("Work/Test/log.txt", "Строка, которая будет записана в конец файла");

ReadBinaryAsJSON

Предоставляет содержимое бинарного файла для чтения.

Синтаксис

string ReadBinaryAsJSON(string FilePath, string Type, uint8 Offset, uint2 Count)

Параметры

Параметр Тип Описание
FilePath string Относительный путь к бинарному файлу относительно значения свойства Корневой путь компонента. Допускается использование прямых (/) или обратных (\\) слешей. При использовании обратных слешей они должны быть экранированы.
Type string Тип элементов бинарного файла.
Offset uint8 Позиция, с которой нужно начать чтение.
Count uint2 Длина отрезка данных.

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

Возвращает строку в формате JSON с содержимым из бинарного файла.

Примеры

Считать из бинарного файла bin.dat в текстовое поле 20 элементов типа int2. Считывание начинать с 100 позиции.

TextEdit.Text = FileSystem.ReadBinaryAsJSON("bin.dat", "int2", 100, 20);

WriteTextFile

Метод устарел.

Создает текстовый файл *.txt и записывает в него указанную строку.

Синтаксис

void WriteTextFile(string FilePath, string Content)

Параметры

Параметр Тип Описание
FilePath string Относительный путь к текстовому файлу относительно значения свойства Корневой путь компонента. Допускается использование прямых (/) или обратных (\\) слешей. При использовании обратных слешей они должны быть экранированы.
Content string Текстовая строка.

Примеры

Записать строку текста в файл по указанному пути.

Files.WriteTextFile("Work/Test/log.txt", "Содержимое для текстового файла");

CanonicalPath

Нормализует переданный путь (приводит разделитель пути к / и убирает переходы наверх .. ).

Синтаксис

string CanonicalPath(string path)

Параметры

Параметр Тип Описание
Path string Путь до папки или файла пользователя.

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

Возвращает строку, содержащую нормализованный путь.

Примеры

Привести указанный путь к нормализованному виду. Результат поместить в текстовое поле.

TextEdit.Text = FileSystem_1.CanonicalPath("C:\\Work\\..");
// Результат выполнения: "C:/"

ToGeneric

Заменяет все разделители пути на единый /.

Синтаксис

string ToGeneric(string Path)

Параметры

Параметр Тип Описание
Path string Путь до папки или файла пользователя.

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

Возвращает строку с путем, в котором все разделители заменены на /.

Примеры

Вернуть в текстовое поле строку пути с заменой разделителей на единый /.

TextEdit.Text = FileSystem_1.ToGeneric("C:\\Work\\Test\\..");
// Результат выполнения: "C:/Work/Test/.."

ToNative

Заменяет единый / разделитель частей пути на платформенный.

Синтаксис

string ToNative(string Path)

Параметры

Параметр Тип Описание
Path string Путь до папки или файла пользователя.

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

Возвращает строку с путем, в котором единые разделители заменены на платформенный.

Примеры

Вернуть в текстовое поле строку пути с заменой разделителей на используемые ОС.

TextEdit.Text = FileSystem_1.ToNative("C:/Work/Test/..");
// Результат выполнения на ОС Windows: "C:\Work\Test\.."
// Результат выполнения на ОС Linux: "C:/Work/Test/.."

PreferredSeparator

Возвращает используемый ОС разделитель в строке пути.

Синтаксис

string PreferredSeparator()

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

Возвращает строку с символом разделителя, используемого операционной системой для путей.

Примеры

Вернуть в текстовое поле используемый ОС разделитель элементов в строке пути.

TextEdit.Text = FileSystem_1.PreferredSeparator();
// Результат выполнения на ОС Windows: "\"
// Результат выполнения на ОС Linux: "/"

ParentPath

Возвращает родительский путь в пределах корневого пути, заданного в свойстве Корневой путь.

Синтаксис

string ParentPath(string Path)

Параметры

Параметр Тип Описание
Path string Относительный путь до папки или файла относительно значения свойства Корневой путь компонента. Допускается использование прямых (/) или обратных (\\) слешей. При использовании обратных слешей они должны быть экранированы.

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

Возвращает строку с родительским путем в пределах корневого пути. В случае отсутствия родительского пути возвращает точку .

Примеры

Вернуть в текстовое поле родительский путь.

TextEdit.Text = FileSystem_1.ParentPath("Work/Test/");
// Результат выполнения: "Work"

HasFileName

Проверяет, есть ли имя файла по указанному пути.

Синтаксис

bool HasFileName(string Path)

Параметры

Параметр Тип Описание
Path string Относительный путь до папки или файла относительно значения свойства Корневой путь компонента. Допускается использование прямых (/) или обратных (\\) слешей. При использовании обратных слешей они должны быть экранированы.

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

true В указанном пути содержится имя файла (путь указывает на файл).
false В указанном пути не содержится имени файла (путь указывает на директорию).

Примеры

Если для указанного пути имя файла существует, вывести в поле ввода: Имя файла существует.

if (FileSystem_1.HasFileName("Work/Test/file.txt"))
{
  TextEdit.Text = "Имя файла существует";
};

HasParentPath

Есть ли родительский путь в пределах корневого пути, заданного в свойстве Корневой путь.

Синтаксис

bool HasParentPath(string Path)

Параметры

Параметр Тип Описание
Path string Относительный путь до папки или файла относительно значения свойства Корневой путь компонента. Допускается использование прямых (/) или обратных (\\) слешей. При использовании обратных слешей они должны быть экранированы.

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

true Родительский путь существует.
false Родительского пути не существует.

Примеры

Если для указанного пути родитель существует, вывести в поле ввода: Родитель существует.

if (FileSystem_1.HasParentPath("Work/Test/.."))
{
  TextEdit.Text = "Родитель существует";
};

IsParent

Является ли parentPath родителем childPathв пределах корневого пути, заданного в свойстве Корневой путь.

Синтаксис

bool IsParent(string parentPath, string childPath)

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

true parentPath является родителем для childPath.
false parentPath не является родителем для childPath.

Параметры

Параметр Тип Описание
parentPath string Относительный родительский путь до папки или файла относительно значения свойства Корневой путь компонента. Допускается использование прямых (/) или обратных (\\) слешей. При использовании обратных слешей они должны быть экранированы.
childPath string Относительный дочерний путь до папки или файла относительно значения свойства Корневой путь компонента. Допускается использование прямых (/) или обратных (\\) слешей. При использовании обратных слешей они должны быть экранированы.

Примеры

Проверить, является ли первый путь родителем второго. Результат вывести в журнал исполнения.

DebugTool_1.Log(String.ToString(FileSystem_1.IsParent("Work/", "Work/Test/..")));
// Результат выполнения: "false"

AbsolutePath

Возвращает полный абсолютный путь (достроенный с помощью Корневой путь ) для переданного относительного.

При корневом пути по умолчанию / принимаются все полные пути.

При иных значениях Корневой путь принимаются только относительные пути.

Синтаксис

string AbsolutePath(string Path)

Параметры

Параметр Тип Описание
Path string Путь до папки или файла пользователя.

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

Возвращает строку с полным абсолютным путем, сконструированным с использованием значения свойства Корневой путь для переданного относительного пути.

Примеры

Вернуть в текстовое поле абсолютный путь для переданного относительного.

// RootPath = "C:/"
TextEdit.Text = FileSystem_1.AbsolutePath("Work/Test");
// Результат выполнения: "C:/Work/Test"

RelativePath

Возвращает относительный путь (часть без Корневой путь ) для переданного абсолютного.

Синтаксис

string RelativePath(string Path)

Параметры

Параметр Тип Описание
Path string Абсолютный путь до папки или файла.

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

Возвращает строку с относительным путем, представляющим часть пути без учета значения свойства Корневой путь, для переданного абсолютного пути.

Примеры

Вернуть в текстовое поле относительный путь для переданного абсолютного.

TextEdit.Text = FileSystem_1.RelativePath("C:/Work/Test/");
// Результат выполнения: "Work/Test"

FileName

Предоставляет название объекта файловой системы, переданного по пути.

Синтаксис

string FileName(string Path)

Параметры

Параметр Тип Описание
Path string Относительный путь до файла относительно значения свойства Корневой путь компонента. Допускается использование прямых (/) или обратных (\\) слешей. При использовании обратных слешей они должны быть экранированы.

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

Возвращает строку с названием файла из переданного пути. Если путь не содержит файла (только папки), возвращается пустая строка.

Примеры

Вернуть в текстовое поле полное имя файла из переданного пути.

TextEdit.Text = FileSystem_1.FileName("Work/Test/v8.dll");
// Результат выполнения: "v8.dll"

Extension

Возвращает расширение элемента файловой системы.

Синтаксис

string Extension(string Path)

Параметры

Параметр Тип Описание
Path string Относительный путь до файла относительно значения свойства Корневой путь компонента. Допускается использование прямых (/) или обратных (\\) слешей. При использовании обратных слешей они должны быть экранированы.

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

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

Примеры

Вернуть в текстовое поле только расширение файла из переданного пути

TextEdit.Text = FileSystem_1.Extension("Work/Test/v8.dll");
// Результат выполнения: ".dll"

Stem

Возвращает имя файла без расширения.

Синтаксис

string Stem(string Path)

Параметры

Параметр Тип Описание
Path string Относительный путь до файла относительно значения свойства Корневой путь компонента. Допускается использование прямых (/) или обратных (\\) слешей. При использовании обратных слешей они должны быть экранированы.

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

Возвращает строку, содержащую название файла без расширения из переданного пути.

Примеры

Вернуть в текстовое поле только имя файла без расширения.

TextEdit.Text = FileSystem_1.Stem("Work/Test/v8.dll");
// Результат выполнения: "v8"

IsFile

Указывает ли путь на файл.

Синтаксис

bool IsFile(string Path)

Параметры

Параметр Тип Описание
Path string Относительный путь до файла относительно значения свойства Корневой путь компонента. Допускается использование прямых (/) или обратных (\\) слешей. При использовании обратных слешей они должны быть экранированы.

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

true Возвращается в случае, если файл с заданным в параметре Path существует.
false Возвращается в случае, если файл с заданным в параметре Path не существует.

Примеры

Проверить, указывает ли переданный путь на файл. Результат вывести в журнал исполнения.

DebugTool_1.Log(String.ToString(FileSystem_1.IsFile("Work/Test/v8.dll")));
// Результат выполнения: true

IsDirectory

Указывает ли путь на директорию.

Синтаксис

bool IsDirectory(string Path)

Параметры

Параметр Тип Описание
Path string Относительный путь до папки или файла относительно значения свойства Корневой путь компонента. Допускается использование прямых (/) или обратных (\\) слешей. При использовании обратных слешей они должны быть экранированы.

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

true Возвращается в случае, если директория с заданным в параметре Path существует.
false Возвращается в случае, если директория с заданным в параметре Path не существует.

Примеры

Проверить, указывает ли переданный путь на директорию. Результат вывести в журнал исполнения.

DebugTool_1.Log(String.ToString(FileSystem_1.IsDirectory("Work/Test/")));
// Результат выполнения: true

Указывает ли путь на символическую ссылку (симлинк).

Синтаксис

bool IsSymLink(string Path)

Параметры

Параметр Тип Описание
Path string Относительный путь до папки или файла относительно значения свойства Корневой путь компонента. Допускается использование прямых (/) или обратных (\\) слешей. При использовании обратных слешей они должны быть экранированы.

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

true Возвращается в случае, если симлинк с заданным в параметре Path существует.
false Возвращается в случае, если симлинк с заданным в параметре Path не существует.

Примеры

Проверить, указывает ли переданный путь на символическую ссылку. Результат вывести в журнал исполнения.

DebugTool_1.Log(String.ToString(FileSystem_1.IsSymLink("Work/Test/")));
// Результат выполнения: false

FileSize

Предоставляет сведения о размере файла.

Синтаксис

uint8 FileSize(string Path)

Параметры

Параметр Тип Описание
Path string Относительный путь до файла относительно значения свойства Корневой путь компонента. Допускается использование прямых (/) или обратных (\\) слешей. При использовании обратных слешей они должны быть экранированы.

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

Возвращает значение типа uint8, представляющее размер файла в байтах. Если путь указывает на директорию или ссылку, возвращается 0.

Примеры

Вывести в журнал исполнения размер файла в байтах.

DebugTool_1.Log(String.ToString(FileSystem_1.FileSize("Work/Test/v8.dll")));
// Результат выполнения: 20 914 176

CreatedTime

Предоставляет сведения о времени создания элемента файловой системы.

Для возврата даты-времени в виде строки необходимо использовать функции для работы с метками времени. Подробнее об этом описано в документации на Alpha.Om.

Синтаксис

timestamp CreatedTime(string Path)

Параметры

Параметр Тип Описание
Path string Относительный путь до файла относительно значения свойства Корневой путь компонента. Допускается использование прямых (/) или обратных (\\) слешей. При использовании обратных слешей они должны быть экранированы.

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

Возвращает значение типа timestamp, представляющее время создания элемента файловой системы.

Примеры

Вывести в текстовое поле время создания файла.

TextEdit.Text = DateTime.ToString(FileSystem_1.CreatedTime("Work/Test/v8.dll"), "%d/%m/%Y-%H:%M:%S.%f");
// Результат выполнения: "12/03/2023-23:42:52.000000"

ModifiedTime

Предоставляет сведения о времени последнего изменения элемента файловой системы.

Для возврата даты-времени в виде строки необходимо использовать функции для работы с метками времени. Подробнее об этом описано в документации на Alpha.Om.

Синтаксис

timestamp ModifiedTime(string Path)

Параметры

Параметр Тип Описание
Path string Относительный путь до файла относительно значения свойства Корневой путь компонента. Допускается использование прямых (/) или обратных (\\) слешей. При использовании обратных слешей они должны быть экранированы.

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

Возвращает значение типа timestamp, представляющее время последнего изменения элемента файловой системы.

Примеры

Вывести в текстовое поле время последнего изменения файла.

TextEdit.Text = DateTime.ToString(FileSystem_1.ModifiedTime("Work/Test/v8.dll"), "%d/%m/%Y-%H:%M:%S.%f");
// Результат выполнения: "12/03/2023-23:42:52.000000"