Alpha.Community

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

Функции

Open

Открывает файл, указанный в свойстве Путь к файлу в режиме, заданном в свойстве Режим открытия. При этом используется кодировка, указанная в свойстве Кодировка. Если свойство Определять Unicode кодировку установлено в true и в файле обнаружен маркер последовательности байтов (BOM), кодировка может быть скорректирована автоматически.

Синтаксис

bool Open()

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

true Файл успешно открыт.
false Открытие файла не удалось (например, файл не существует, недостаточно прав или ошибка в параметрах).

Примеры

Открыть файл для чтения с указанной кодировкой и автоматическим определением Unicode:

TextFile_1.Path = "C:\\Users\\User1\\Desktop\\12.txt";
TextFile_1.OpenMode = 1; // Доступ на чтение
TextFile_1.Encoding = "UTF-8";
TextFile_1.AutoDetectUnicode = true;
TextFile_1.Open();

Close

Закрывает файл, который был открыт ранее с помощью функции Open().

Синтаксис

void Close()

Примеры

Закрыть файл после завершения работы с ним:

// Открываем файл 
TextFile_1.Open();
// Выполняем операции с файлом
// ...
// Закрываем файл
TextFile_1.Close();

Flush

Сбрасывает все данные из буфера в файл.

Используется, если необходимо гарантировать, что данные будут немедленно сохранены, например, перед закрытием файла или выполнением критических операций.

Синтаксис

bool Flush()

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

true Если сброс был выполнен успешно.
false Если произошла ошибка во время сброса данных.

Примеры

Сбросить буфер после записи данных для обеспечения их сохранности:

// Открываем файл для добавления данных
TextFile_1.Path = "C:\\Users\\User1\\Desktop\\1.txt";
TextFile_1.Open();
// Добавляем данные в буфер
TextFile_1.Write("More data");
// Сбрасываем буфер в файл
TextFile_1.Flush();
// Можно продолжить работу или закрыть файл
TextFile_1.Close();

Seek

Устанавливает текущую позицию в файле. После вызова этой функции курсор перемещается на указанную позицию в файле, что позволяет читать или записывать данные с этой позиции.

Синтаксис

bool Seek(int8 pos)

Параметры

Параметр Тип Описание
pos int8 Позиция в файле в байтах, на которую нужно переместить курсор. Значение должно быть в пределах от 0 до общего размера файла.

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

true Если операция перемещения курсора выполнена успешно.
false Если перемещение курсора невозможно (например, если pos выходит за пределы размера файла).

Примеры

Переместить курсор в начало файла

TextFile_1.Seek(0);

Read

Считывает данные из файла, начиная с текущей позиции, в количестве не более чем maxLen символов. Если доступно меньше данных, чем указано в maxLen, будет возвращено только доступное количество данных.

Синтаксис

string Read(int8 maxLen)

Параметры

Параметр Тип Описание
maxLen int8 Максимальная длина данных для чтения в байтах.

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

string Прочитанные данные

Примеры

Прочитать первые 20 байт файла:

TextFile_1.Read(20);

ReadChar

Считывает один символ из файла, начиная с текущей позиции.

Синтаксис

string ReadChar()

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

string Один символ из файла

Примеры

Прочитать один символ из файла:

TextFile_1.ReadChar();

ReadWord

Читает слово из файла. Слово определяется как последовательность символов до первого пробельного символа (пробел, табуляция, новая строка и т.д.).

Синтаксис

string ReadWord()

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

string Слово, прочитанное из файла. Если достигнут конец файла или не найдено слово, возвращается пустая строка.

Примеры

Считать первое слово из файла:

TextFile_1.ReadWord();

ReadLine

Читает строку из файла. Под строкой понимается последовательность символов до символа переноса строки (\n). Метод удобен для построчного чтения файлов. Если достигнут конец файла, функция возвращает пустую строку.

Синтаксис

string ReadLine()

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

string

Cтрока, прочитанная из файла до символа переноса строки. Если достигнут конец файла, возвращается пустая строка.

Примеры

Прочитать одну строку из файла:

TextFile_1.ReadLine();

ReadAll

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

Синтаксис

string ReadAll()

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

string

Cодержимое файла. Если файл пуст, возвращается пустая строка.

Примеры

Прочитать все содержимое текстового файла:

TextFile_1.ReadAll();

ReadInt1

Считывает 1-байтовое целое число со знаком (типа int1) из файла

Синтаксис

int1 ReadInt1()

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

int1 Прочитанное 1-байтовое целое число со знаком.

Примеры

Прочитать одно целое число из файла:

TextFile_1.ReadInt1();

ReadInt2

Считывает 2-байтовое целое число со знаком (типа int2) из файла

Синтаксис

int2 ReadInt2()

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

int2 Прочитанное 2-байтовое целое число со знаком.

Примеры

Считать одно целое число int2 из файла

TextFile_1.ReadInt2();

ReadInt4

Считывает 4-байтовое целое число со знаком (типа int4) из файла

Синтаксис

int4 ReadInt4()

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

int4 Прочитанное 4-байтовое целое число со знаком.

Примеры

Считать одно целое число int4 из файла

TextFile_1.ReadInt4();

ReadInt8

Считывает 8-байтовое целое число со знаком (типа int8) из файла

Синтаксис

int8 ReadInt8()

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

int8 Прочитанное 8-байтовое целое число со знаком.

Примеры

Считать одно число int8 из файла

TextFile_1.ReadInt8();

ReadUint1

Считывает 1-байтовое целое число без знака (типа uint1) из файла

Синтаксис

uint1 ReadUint1()

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

uint1 Прочитанное 1-байтовое целое число без знака.

Примеры

Считать одно число Uint1 из файла

TextFile_1.ReadUint1();

ReadUint2

Считывает 2-байтовое целое число без знака (типа uint2) из файла

Синтаксис

uint2 ReadUint2()

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

uint2 Прочитанное 2-байтовое целое число без знака.

Примеры

Считать одно число Uint2 из файла

TextFile_1.ReadUint2();

ReadUint4

Считывает 4-байтовое целое число без знака (типа uint4) из файла

Синтаксис

uint4 ReadUint4()

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

uint4 Прочитанное 4-байтовое целое число без знака.

Примеры

Считать одно число Uint4 из файла

TextFile_1.ReadUint4();

ReadUint8

Считывает 8-байтовое целое число без знака (типа uint8) из файла.

Синтаксис

uint8 ReadUint8()

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

uint8 Прочитанное 8-байтовое целое число без знака.

Примеры

Считать одно число Uint8 из файла

TextFile_1.ReadUint8();

ReadFloat

Считывает число с плавающей запятой одинарной точности (типа float) из файла.

Синтаксис

float ReadFloat()

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

float Прочитанное число с плавающей запятой одинарной точности.

Примеры

Cчитать одно число float из файла

TextFile_1.ReadFloat();

ReadDouble

Считывает число с плавающей запятой двойной точности (типа double) из файла

Синтаксис

double ReadDouble()

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

double Прочитанное число с плавающей запятой двойной точности.

Примеры

Cчитать одно число double из файла

TextFile_1.ReadDouble();

Write

Записывает строку данных в файл. Строка записывается без добавления символа переноса строки в конце.

Синтаксис

bool Write(string data)

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

true Запись данных выполнена успешно.
false Произошла ошибка при записи.

Параметры

Параметр Тип Описание
data string Строка данных, которая будет записана в файл.

Примеры

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

TextFile_1.Write("Пример данных для записи.");

WriteLine

Функция записывает строку данных в файл и автоматически добавляет символ переноса строки в конце. Удобно для записи построчных данных.

Синтаксис

bool WriteLine(string data)

Параметры

Параметр Тип Описание
data string Строка данных, которая будет записана в файл с добавлением переноса строки.

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

true Запись данных выполнена успешно.
false Произошла ошибка при записи.

Примеры

Записать данные в файл с переносом строки

TextFile_1.WriteLine("New Data.");

WriteInt1

Записывает одно байтовое целое число (типа int1) в файл

Синтаксис

bool WriteInt1(int1 number)

Параметры

Параметр Тип Описание
number int1 Целое число, которое будет записано в файл

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

true Запись данных выполнена успешно.
false Произошла ошибка при записи.

Примеры

Записать число 127 в файл

TextFile_1.WriteInt1(127);

WriteInt2

Записывает 2-байтовое целое число (типа int2) в файл

Синтаксис

bool WriteInt2(int2 number)

Параметры

Параметр Тип Описание
number int2 16-битное целое число, которое будет записано в файл.

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

true Запись данных выполнена успешно.
false Произошла ошибка при записи.

Примеры

Записать число 32000 в файл

TextFile_1.WriteInt2(32000);

WriteInt4

Записывает 4-байтовое целое число (типа int4) в файл

Синтаксис

bool WriteInt4(int4 number)

Параметры

Параметр Тип Описание
number int4 32-битное целое число, которое будет записано в файл.

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

true Запись данных выполнена успешно.
false Произошла ошибка при записи.

Примеры

Записать число 2147483647 в файл

TextFile_1.WriteInt4(2147483647);

WriteInt8

Записывает 8-байтовое целое число (типа int8) в файл

Синтаксис

bool WriteInt8(int8 number)

Параметры

Параметр Тип Описание
number int8 64-битное целое число, которое будет записано в файл.

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

true Запись данных выполнена успешно.
false Произошла ошибка при записи.

Примеры

Записать число 9223372036854775807 в файл

TextFile_1.WriteInt8(9223372036854775807);

WriteUint1

Записывает 1-байтовое целое число без знака (типа uint1) в файл.

Синтаксис

bool WriteUint1(uint1 number)

Параметры

Параметр Тип Описание
number uint1 8-битное целое число без знака, которое будет записано в файл.

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

true Запись данных выполнена успешно.
false Произошла ошибка при записи.

Примеры

Записать 8-битное число без знака в файл:

TextFile_1.WriteUint1(255);

WriteUint2

Записывает 2-байтовое целое число без знака (типа uint2) в файл

Синтаксис

bool WriteUint2(uint2 number)

Параметры

Параметр Тип Описание
number uint2 16-битное целое число без знака, которое будет записано в файл.

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

true Запись данных выполнена успешно.
false Произошла ошибка при записи.

Примеры

Записать 16-битное число без знака в файл:

TextFile_1.WriteUint2(65535);

WriteUint4

Записывает 4-байтовое целое число без знака (типа uint4) в файл

Синтаксис

bool WriteUint4(uint4 number)

Параметры

Параметр Тип Описание
number uint4 32-битное целое число без знака, которое будет записано в файл.

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

true Запись данных выполнена успешно.
false Произошла ошибка при записи.

Примеры

Записать 32-битное число без знака в файл:

TextFile_1.WriteUint4(4294967295);

WriteUint8

Записывает 8-байтовое целое число без знака (типа uint8) в файл

Синтаксис

bool WriteUint8(uint8 number)

Параметры

Параметр Тип Описание
number uint8 64-битное целое число без знака, которое будет записано в файл.

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

true Запись данных выполнена успешно.
false Произошла ошибка при записи.

Примеры

Записать 64-битное число без знака в файл:

TextFile_1.WriteUint8(18446744073709551615);

WriteFloat

Записывает число с плавающей запятой (типа float) в файл

Синтаксис

bool WriteFloat(float number)

Параметры

Параметр Тип Описание
number float Число с плавающей запятой одинарной точности, которое будет записано в файл.

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

true Запись данных выполнена успешно.
false Произошла ошибка при записи.

Примеры

Записать число 3.14159 в файл:

TextFile_1.WriteFloat(3.14159f);

WriteDouble

Записывает число с плавающей запятой двойной точности (типа double) в файл.

Синтаксис

bool WriteDouble(double number)

Параметры

Параметр Тип Описание
number double Число с плавающей запятой двойной точности, которое будет записано в файл.

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

true Запись данных выполнена успешно.
false Произошла ошибка при записи.

Примеры

Записать число 3.141592653589793 в файл:

TextFile_1.WriteDouble(3.141592653589793);