Справочник по языку программирования MQL5

Подождите немного. Документ загружается.

Файловые операции

701

FileWriteArray

Записывает в файл типа BIN массивы любых типов, кроме строковых (может быть массив

структур, не содержащих строки и динамические массивы).

uint FileWriteArray(

int file_handle, // handle файла

void array[], // массив

int start_item=0, // начальный индекс в массиве

int items_count=WHOLE_ARRAY // количество элементов

);

Параметры

file_handle

[in] Файловый описатель, возвращаемый функцией FileOpen().

array[]

[out] Массив для записи.

start_item=0

[in] Начальный индекс в массиве (номер первого записываемого элемента).

items_count=WHOLE_ARRAY

[in] Количество записываемых элементов (WHOLE_ARRAY означает, что записываются все

элементы начиная с номера start_item до конца массива).

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

Количество записанных элементов.

Примечание

Строковый массив может записываться только в файл типа TXT. В этом случае строки

автоматически завершаются символами конца строки "\r\n". В зависимости от типа файла ANSI

или UNICODE, строки преобразовываются к ansi-кодировке, либо нет.

Смотри также

Переменные

Файловые операции

702

FileWriteDouble

Записывает в файл значение параметра типа double с текущего положения файлового указателя.

uint FileWriteDouble(

int file_handle, // handle файла

double dvalue // значения для записи

);

Параметры

file_handle

[in] Файловый описатель, возвращаемый функцией FileOpen().

dvalue

[in] Значение типа double.

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

В случае удачи функция возвращает количество записанных байт (в данном случае sizeof

(double)=8). Файловый указатель перемещается на это же количество байт.

Смотри также

Вещественные типы (double, float)

Файловые операции

703

FileWriteFloat

Записывает в bin-файл значение параметра типа float с текущего положения файлового

указателя.

uint FileWriteFloat(

int file_handle, // handle файла

float fvalue // записываемое значение

);

Параметры

file_handle

[in] Файловый описатель, возвращаемый функцией FileOpen().

fvalue

[in] Значение типа float.

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

В случае удачи функция возвращает количество записанных байт (в данном случае sizeof(float)

=4). Файловый указатель перемещается на это же количество байт.

Смотри также

Вещественные типы (double, float), FileWriteDouble

Файловые операции

704

FileWriteInteger

Записывает в bin-файл значение параметра типа int с текущего положения файлового указателя.

uint FileWriteInteger(

int file_handle, // handle файла

int ivalue, // записываемое значение

int size=INT_VALUE // размер в байтах

);

Параметры

file_handle

[in] Файловый описатель, возвращаемый функцией FileOpen().

ivalue

[in] Целое значение.

size=INT_VALUE

[in] Количество байт (до 4 включительно), которые нужно записать. Предусмотрены

соответствующие константы: CHAR_VALUE=1, SHORT_VALUE=2 и INT_VALUE=4, таким образом

функция может записать целое значение типа char, uchar, short, ushort, int или uint

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

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

перемещается на это же количество байт.

Смотри также

IntegerToString, StringToInteger, Целые типы

Файловые операции

705

FileWriteLong

Записывает в bin-файл значение параметра типа long с текущего положения файлового указателя.

uint FileWriteLong(

int file_handle, // handle файла

long lvalue // записываемое значение

);

Параметры

file_handle

[in] Файловый описатель, возвращаемый функцией FileOpen().

lvalue

[in] Значение типа long.

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

В случае удачи функция возвращает количество записанных байт (в данном случае sizeof(long)

=8). Файловый указатель перемещается на это же количество байт.

Смотри также

Целые типы, FileWriteInteger

Файловые операции

706

FileWriteString

Записывает в файл типа BIN или TXT значение параметра типа string с текущего положения

файлового указателя. При записи в файл типа TXT если в строке присутствует символ '\n' (LF) без

предшествующего символа '\r' (CR), то перед символом '\n' дописывается отсутствующий символ

'\r'.

uint FileWriteString(

int file_handle, // handle файла

string svalue, // записываемая строка

int size=-1 // количество символов

);

Параметры

file_handle

[in] Файловый описатель, возвращаемый функцией FileOpen().

svalue

[in] Строка.

size=-1

[in] Количество символов, которые нужно записать. Параметр необходим для записи строки в

файл типа BIN. Если размер не указан, то записывается вся строка без завершающего 0. Если

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

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

количеством нулей. Для файлов типа TXT этот параметр игнорируется и строка записывается

полностью.

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

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

перемещается на это же количество байт.

Примечание

Следует иметь в виду, что при записи в файл, открытый с флагом FILE_UNICODE (либо без

флага FILE_ANSI), то количество записанных байт будет в 2 раза больше количества записанных

символов строки. При записи в файл, открытый с флагом FILE_ANSI, количество записанных

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

Смотри также

Тип string, StringFormat

Файловые операции

707

FileWriteStruct

Записывает в bin-файл содержимое структуры, переданной в качестве параметра, с текущего

положения файлового указателя.

uint FileWriteStruct(

int file_handle, // handle файла

any_simple_struct str_object&, // ссылка на объект

int size=-1 // размер для записи в байтах

);

Параметры

file_handle

[in] Файловый описатель, возвращаемый функцией FileOpen().

str_object&

[in] Ссылка на объект указанной структуры. Структура не должна содержать строки,

динамические массивы и виртуальные функции.

size=-1

[in] Количество байт, которые нужно записать. Если размер не указан или указано большее

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

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

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

перемещается на это же количество байт.

Смотри также

Структуры и классы

Файловые операции

708

FolderCreate

Создает директорию в директории Files (в зависимости от значения common_flag)

bool FolderCreate(

string folder_name, // строка с именем создаваемой папки

int common_flag=0 // область действия

);

Параметры

folder_name

[in] Имя директории, которую требуется создать. Содержит полный путь к папке.

common_flag=0

[in] Флаг, определяющий местоположение директории. Если common_flag=FILE_COMMON, то

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

директория находится в локальной папке (MQL5\files или MQL5\tester\files в случае

тестирования).

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

Возвращает true в случае успеха, иначе false.

Примечание

Из соображений безопасности в языке MQL5 строго контролируется работа с файлами. Файлы, с

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

пределами файловой "песочницы".

Файловые операции

709

FolderDelete

Удаляет указанную директорию. Если папка не пуста, то она не может быть удалена.

bool FolderDelete(

string folder_name, // строка с именем удаляемой папки

int common_flag=0 // область действия

);

Параметры

folder_name

[in] Имя директории, которую требуется удалить. Содержит полный путь к папке.

common_flag=0

[in] Флаг, определяющий местоположение директории. Если common_flag=FILE_COMMON, то

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

директория находится в локальной папке (MQL5\files или MQL5\tester\files в случае

тестирования).

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

Возвращает true в случае успеха, иначе false.

Примечание

Из соображений безопасности в языке MQL5 строго контролируется работа с файлами. Файлы, с

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

пределами файловой "песочницы".

Если директория содержит хоть один файл и/или поддиректорию, то удаление такой

директории невозможно, ее необходимо предварительно очистить. Тотальная очистка папки от

всех файлов и всех вложенных подпапок осуществляется при помощи функции FolderClean().

Файловые операции

710

FolderClean

Удаляет все файлы в указанной папке.

bool FolderClean(

string folder_name, // строка с именем папки

int common_flag=0 // область действия

);

Параметры

folder_name

[in] Имя директории, в которой требуется удалить все файлы. Содержит полный путь к папке.

common_flag=0

[in] Флаг, определяющий местоположение директории. Если common_flag=FILE_COMMON, то

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

директория находится в локальной папке (MQL5\files или MQL5\tester\files в случае

тестирования).

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

Возвращает true в случае успеха, иначе false.

Примечание

Из соображений безопасности в языке MQL5 строго контролируется работа с файлами. Файлы, с

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

пределами "файловой песочницы".

Осторожно пользуйтесь этой функцией, так как все файлы и все вложенные поддиректории

удаляются безвозвратно.