Справочный указатель
Встроенные функции
Здесь собраны встроенные функции Axiom и точные зарегистрированные формы их вызова: имя, аргументы, результат и ссылка на тематическую статью, где описаны поведение, ограничения и примеры.
Содержание
В указателе представлены 282 имя встроенных функций и 355 зарегистрированных форм вызова. Каждая форма показана отдельно; все перечисленные в ней аргументы обязательны. Необязательный аргумент представлен отдельной более короткой формой.
T обозначает тип элемента массива, U — тип результата преобразования, A — тип аккумулятора. Это справочные обозначения. Допустимые числовые типы: INTEGER, LONG, DOUBLE, DECIMAL. Ограничения конкретной функции имеют приоритет над общей категорией типа.
ABS
ABS возвращает модуль числа.
Синтаксис, аргументы и результат
ABS(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Допустимые числовые типы и результат описаны ниже. Передайте число, модуль которого требуется получить. |
Результат. Функция возвращает значение того же числового типа, что и первый аргумент.
Описание ABS: поведение, ограничения и примеры
Запускаемые примеры
ACOS
ACOS возвращает арккосинус числа.
Синтаксис, аргументы и результат
ACOS(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Перед вычислением оно преобразуется в DOUBLE. Передайте значение косинуса в диапазоне от -1 до 1 включительно. |
Результат. Функция возвращает число типа DOUBLE.
Описание ACOS: поведение, ограничения и примеры
Запускаемые примеры
ACOSH
ACOSH возвращает обратный гиперболический косинус числа.
Синтаксис, аргументы и результат
ACOSH(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Перед вычислением оно преобразуется в DOUBLE. Передайте число не меньше 1, для которого требуется вычислить обратный гиперболический косинус. |
Результат. Функция возвращает число типа DOUBLE.
Описание ACOSH: поведение, ограничения и примеры
Запускаемые примеры
APPENDFILE
APPENDFILE дописывает текст в конец файла.
Синтаксис, аргументы и результат
APPENDFILE(<путь>, <текст>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к файлу. |
<текст> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка текста содержит символы, которые нужно записать. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
APPENDFILE(<путь>, <текст>, <кодировка>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к файлу. |
<текст> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка текста содержит символы, которые нужно записать. |
<кодировка> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка кодировки выбирает UTF-8, WINDOWS-1251, UTF-16LE или UTF-16BE; регистр и крайние пробелы игнорируются. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание APPENDFILE: поведение, ограничения и примеры
Запускаемые примеры
ARRAYAVERAGE
ARRAYAVERAGE возвращает среднее арифметическое числовых элементов массива.
Синтаксис, аргументы и результат
ARRAYAVERAGE(<массив>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
Результат. Функция возвращает число типа DOUBLE.
Описание ARRAYAVERAGE: поведение, ограничения и примеры
Запускаемые примеры
ARRAYBINARYSEARCH
ARRAYBINARYSEARCH ищет первое совпадение двоичным поиском в отсортированном массиве.
Синтаксис, аргументы и результат
ARRAYBINARYSEARCH(<массив>, <значение>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<значение> | Тип передаваемого значения должен совпадать с типом элемента массива. Искомое значение должно иметь тип элемента массива либо допускать преобразование к этому типу. Совпадение проверяется среди видимых элементов. |
Результат. Для одномерного массива функция возвращает индекс типа INTEGER. Для многомерного массива функция возвращает одномерный массив INTEGER[] с координатами найденного элемента.
ARRAYBINARYSEARCH(<массив>, <значение>, <измерение>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<значение> | Тип передаваемого значения должен совпадать с типом элемента массива. Искомое значение должно иметь тип элемента массива либо допускать преобразование к этому типу. Совпадение проверяется среди видимых элементов. |
<измерение> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER выбирает измерение от 1 до ранга включительно. ROW равно 1, COLUMN равно 2. Для преобразований массива ранга 2 и выше этот аргумент обязателен. |
Результат. Для одномерного массива функция возвращает индекс типа INTEGER. Для многомерного массива функция возвращает одномерный массив INTEGER[] с координатами найденного элемента.
Описание ARRAYBINARYSEARCH: поведение, ограничения и примеры
Запускаемые примеры
ARRAYBOUNDS
ARRAYBOUNDS возвращает таблицу нижних и верхних границ всех измерений.
Синтаксис, аргументы и результат
ARRAYBOUNDS(<массив>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
Результат. Функция возвращает двумерный массив целых чисел типа INTEGER[,].
Описание ARRAYBOUNDS: поведение, ограничения и примеры
Запускаемые примеры
ARRAYCLONE
ARRAYCLONE создаёт независимую копию видимой части массива.
Синтаксис, аргументы и результат
ARRAYCLONE(<массив>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
Результат. Функция возвращает массив с типом элементов исходного массива. Правила сохранения или изменения границ описаны в тематической статье этой функции.
Описание ARRAYCLONE: поведение, ограничения и примеры
Запускаемые примеры
ARRAYCONCAT
ARRAYCONCAT объединяет содержимое двух массивов в новую копию.
Синтаксис, аргументы и результат
ARRAYCONCAT(<левый операнд>, <правый операнд>)| Аргумент | Что передать |
|---|---|
<левый операнд> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив задаёт первую часть объединённого результата. |
<правый операнд> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив того же типа и ранга задаёт вторую часть объединённого результата. |
Результат. Функция возвращает массив с типом элементов исходного массива. Правила сохранения или изменения границ описаны в тематической статье этой функции.
ARRAYCONCAT(<левый операнд>, <правый операнд>, <измерение>)| Аргумент | Что передать |
|---|---|
<левый операнд> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив задаёт первую часть объединённого результата. |
<правый операнд> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив того же типа и ранга задаёт вторую часть объединённого результата. |
<измерение> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER выбирает измерение от 1 до ранга включительно. ROW равно 1, COLUMN равно 2. Для преобразований массива ранга 2 и выше этот аргумент обязателен. |
Результат. Функция возвращает массив с типом элементов исходного массива. Правила сохранения или изменения границ описаны в тематической статье этой функции.
Описание ARRAYCONCAT: поведение, ограничения и примеры
Запускаемые примеры
ARRAYCONTAINS
ARRAYCONTAINS проверяет наличие значения среди видимых элементов массива.
Синтаксис, аргументы и результат
ARRAYCONTAINS(<массив>, <значение>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<значение> | Тип передаваемого значения должен совпадать с типом элемента массива. Искомое значение должно иметь тип элемента массива либо допускать преобразование к этому типу. Совпадение проверяется среди видимых элементов. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание ARRAYCONTAINS: поведение, ограничения и примеры
Запускаемые примеры
ARRAYCOUNT
ARRAYCOUNT подсчитывает совпадения значения в массиве.
Синтаксис, аргументы и результат
ARRAYCOUNT(<массив>, <значение>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<значение> | Тип передаваемого значения должен совпадать с типом элемента массива. Искомое значение должно иметь тип элемента массива либо допускать преобразование к этому типу. Совпадение проверяется среди видимых элементов. |
Результат. Функция возвращает целое число типа INTEGER.
Описание ARRAYCOUNT: поведение, ограничения и примеры
Запускаемые примеры
ARRAYDISTINCT
ARRAYDISTINCT копирует первые появления различных значений в одномерный массив.
Синтаксис, аргументы и результат
ARRAYDISTINCT(<массив>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
Результат. Функция возвращает одномерный массив с типом элементов исходного массива.
Описание ARRAYDISTINCT: поведение, ограничения и примеры
Запускаемые примеры
ARRAYEVERY
ARRAYEVERY проверяет, удовлетворяют ли все элементы пользовательскому условию.
Синтаксис, аргументы и результат
ARRAYEVERY(<массив>, <функция проверки>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<функция проверки> | Передаётся пользовательская функция с подписью FUNCTION(T) AS BOOLEAN. Значение функции принимает элемент и возвращает BOOLEAN; TRUE означает выполнение условия. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание ARRAYEVERY: поведение, ограничения и примеры
Запускаемые примеры
ARRAYFILL
ARRAYFILL заполняет видимые элементы массива одним значением.
Синтаксис, аргументы и результат
ARRAYFILL(<массив>, <значение>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<значение> | Тип передаваемого значения должен совпадать с типом элемента массива. Записываемое значение должно иметь тип элемента массива либо допускать преобразование к этому типу; оно устанавливается для каждого видимого элемента. |
Результат. Функция выполняет действие и не возвращает значение. Используйте вызов как отдельную инструкцию.
Описание ARRAYFILL: поведение, ограничения и примеры
Запускаемые примеры
ARRAYFILTER
ARRAYFILTER копирует элементы, удовлетворяющие пользовательскому условию.
Синтаксис, аргументы и результат
ARRAYFILTER(<массив>, <функция проверки>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<функция проверки> | Передаётся пользовательская функция с подписью FUNCTION(T) AS BOOLEAN. Значение функции принимает элемент и возвращает BOOLEAN; TRUE означает выполнение условия. |
Результат. Функция возвращает одномерный массив с типом элементов исходного массива.
Описание ARRAYFILTER: поведение, ограничения и примеры
Запускаемые примеры
ARRAYFINDALL
ARRAYFINDALL возвращает индексы всех совпадений значения в массиве.
Синтаксис, аргументы и результат
ARRAYFINDALL(<массив>, <значение>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<значение> | Тип передаваемого значения должен совпадать с типом элемента массива. Искомое значение должно иметь тип элемента массива либо допускать преобразование к этому типу. Совпадение проверяется среди видимых элементов. |
Результат. Для одномерного массива функция возвращает массив индексов INTEGER[]. Для многомерного массива функция возвращает двумерный массив INTEGER[,] с координатами найденных элементов.
Описание ARRAYFINDALL: поведение, ограничения и примеры
Запускаемые примеры
ARRAYFLATTEN
ARRAYFLATTEN копирует все видимые элементы в одномерный массив.
Синтаксис, аргументы и результат
ARRAYFLATTEN(<массив>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
Результат. Функция возвращает одномерный массив с типом элементов исходного массива.
Описание ARRAYFLATTEN: поведение, ограничения и примеры
Запускаемые примеры
ARRAYINDEXOF
ARRAYINDEXOF находит первое совпадение значения в массиве.
Синтаксис, аргументы и результат
ARRAYINDEXOF(<массив>, <значение>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<значение> | Тип передаваемого значения должен совпадать с типом элемента массива. Искомое значение должно иметь тип элемента массива либо допускать преобразование к этому типу. Совпадение проверяется среди видимых элементов. |
Результат. Для одномерного массива функция возвращает индекс типа INTEGER. Для многомерного массива функция возвращает одномерный массив INTEGER[] с координатами найденного элемента.
Описание ARRAYINDEXOF: поведение, ограничения и примеры
Запускаемые примеры
ARRAYINSERT
ARRAYINSERT вставляет элемент или срез перед заданным индексом массива.
Синтаксис, аргументы и результат
ARRAYINSERT(<массив>, <индекс>, <значение>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<индекс> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER задаёт логическую позицию вставки либо удаления. |
<значение> | Тип передаваемого значения должен совпадать с типом элемента массива. Для ранга 1 добавляемое значение должно быть совместимо с типом элемента. Для ранга 2 и выше передаётся выделенный массив того же типа элементов, ранга на 1 меньше; его границы должны совпадать со всеми невыбранными измерениями источника. |
Результат. Функция выполняет действие и не возвращает значение. Используйте вызов как отдельную инструкцию.
ARRAYINSERT(<массив>, <индекс>, <значение>, <измерение>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<индекс> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER задаёт логическую позицию вставки либо удаления. |
<значение> | Тип передаваемого значения должен совпадать с типом элемента массива. Для ранга 1 добавляемое значение должно быть совместимо с типом элемента. Для ранга 2 и выше передаётся выделенный массив того же типа элементов, ранга на 1 меньше; его границы должны совпадать со всеми невыбранными измерениями источника. |
<измерение> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER выбирает измерение от 1 до ранга включительно. ROW равно 1, COLUMN равно 2. Для преобразований массива ранга 2 и выше этот аргумент обязателен. |
Результат. Функция выполняет действие и не возвращает значение. Используйте вызов как отдельную инструкцию.
Описание ARRAYINSERT: поведение, ограничения и примеры
Запускаемые примеры
ARRAYISALLOCATED
ARRAYISALLOCATED проверяет, выделено ли хранилище элементов массива.
Синтаксис, аргументы и результат
ARRAYISALLOCATED(<массив>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание ARRAYISALLOCATED: поведение, ограничения и примеры
Запускаемые примеры
ARRAYLASTINDEXOF
ARRAYLASTINDEXOF находит последнее совпадение значения в массиве.
Синтаксис, аргументы и результат
ARRAYLASTINDEXOF(<массив>, <значение>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<значение> | Тип передаваемого значения должен совпадать с типом элемента массива. Искомое значение должно иметь тип элемента массива либо допускать преобразование к этому типу. Совпадение проверяется среди видимых элементов. |
Результат. Для одномерного массива функция возвращает индекс типа INTEGER. Для многомерного массива функция возвращает одномерный массив INTEGER[] с координатами найденного элемента.
Описание ARRAYLASTINDEXOF: поведение, ограничения и примеры
Запускаемые примеры
ARRAYLENGTH
ARRAYLENGTH возвращает число видимых элементов массива.
Синтаксис, аргументы и результат
ARRAYLENGTH(<массив>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
Результат. Функция возвращает целое число типа INTEGER.
Описание ARRAYLENGTH: поведение, ограничения и примеры
Запускаемые примеры
ARRAYMAP
ARRAYMAP преобразует каждый элемент пользовательской функцией и возвращает новый массив.
Синтаксис, аргументы и результат
ARRAYMAP(<массив>, <функция преобразования>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<функция преобразования> | Передаётся пользовательская функция с подписью FUNCTION(T) AS U. Значение функции принимает элемент и возвращает значение нового элемента. |
Результат. Функция возвращает массив с типом элементов U, который задаётся результатом переданной функции преобразования. Ранг и границы совпадают с исходным массивом.
Описание ARRAYMAP: поведение, ограничения и примеры
Запускаемые примеры
ARRAYMAX
ARRAYMAX возвращает наибольшее значение массива.
Синтаксис, аргументы и результат
ARRAYMAX(<массив>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
Результат. Функция возвращает значение того же типа, что и элементы исходного массива.
Описание ARRAYMAX: поведение, ограничения и примеры
Запускаемые примеры
ARRAYMIN
ARRAYMIN возвращает наименьшее значение массива.
Синтаксис, аргументы и результат
ARRAYMIN(<массив>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
Результат. Функция возвращает значение того же типа, что и элементы исходного массива.
Описание ARRAYMIN: поведение, ограничения и примеры
Запускаемые примеры
ARRAYPOP
ARRAYPOP снимает последний элемент или срез выбранного измерения массива.
Синтаксис, аргументы и результат
ARRAYPOP(<массив>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
Результат. Для одномерного массива функция возвращает элемент его типа. Для массива ранга 2 или выше функция возвращает массив с тем же типом элементов и рангом на единицу меньше.
ARRAYPOP(<массив>, <измерение>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<измерение> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER выбирает измерение от 1 до ранга включительно. ROW равно 1, COLUMN равно 2. Для преобразований массива ранга 2 и выше этот аргумент обязателен. |
Результат. Для одномерного массива функция возвращает элемент его типа. Для массива ранга 2 или выше функция возвращает массив с тем же типом элементов и рангом на единицу меньше.
Описание ARRAYPOP: поведение, ограничения и примеры
Запускаемые примеры
ARRAYPUSH
ARRAYPUSH добавляет элемент или срез в конец выбранного измерения массива.
Синтаксис, аргументы и результат
ARRAYPUSH(<массив>, <значение>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<значение> | Тип передаваемого значения должен совпадать с типом элемента массива. Для ранга 1 добавляемое значение должно быть совместимо с типом элемента. Для ранга 2 и выше передаётся выделенный массив того же типа элементов, ранга на 1 меньше; его границы должны совпадать со всеми невыбранными измерениями источника. |
Результат. Функция выполняет действие и не возвращает значение. Используйте вызов как отдельную инструкцию.
ARRAYPUSH(<массив>, <значение>, <измерение>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<значение> | Тип передаваемого значения должен совпадать с типом элемента массива. Для ранга 1 добавляемое значение должно быть совместимо с типом элемента. Для ранга 2 и выше передаётся выделенный массив того же типа элементов, ранга на 1 меньше; его границы должны совпадать со всеми невыбранными измерениями источника. |
<измерение> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER выбирает измерение от 1 до ранга включительно. ROW равно 1, COLUMN равно 2. Для преобразований массива ранга 2 и выше этот аргумент обязателен. |
Результат. Функция выполняет действие и не возвращает значение. Используйте вызов как отдельную инструкцию.
Описание ARRAYPUSH: поведение, ограничения и примеры
Запускаемые примеры
ARRAYRANK
ARRAYRANK возвращает число измерений массива.
Синтаксис, аргументы и результат
ARRAYRANK(<массив>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
Результат. Функция возвращает целое число типа INTEGER.
Описание ARRAYRANK: поведение, ограничения и примеры
Запускаемые примеры
ARRAYREDUCE
ARRAYREDUCE последовательно объединяет элементы с накопленным значением пользовательской функцией.
Синтаксис, аргументы и результат
ARRAYREDUCE(<массив>, <начальное значение>, <функция накопления>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<начальное значение> | Передаётся начальное значение аккумулятора; его тип A определяет тип результата накопления. Значение типа накопителя A начинает свёртку до первого элемента. |
<функция накопления> | Передаётся пользовательская функция с подписью FUNCTION(A, T) AS A. Значение функции принимает текущий накопитель и элемент и возвращает следующий накопитель того же типа. |
Результат. Функция возвращает значение типа A, заданного начальным значением аккумулятора.
Описание ARRAYREDUCE: поведение, ограничения и примеры
Запускаемые примеры
ARRAYREMOVE
ARRAYREMOVE удаляет и возвращает элемент или срез с заданным индексом массива.
Синтаксис, аргументы и результат
ARRAYREMOVE(<массив>, <индекс>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<индекс> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER задаёт логическую позицию вставки либо удаления. |
Результат. Для одномерного массива функция возвращает элемент его типа. Для массива ранга 2 или выше функция возвращает массив с тем же типом элементов и рангом на единицу меньше.
ARRAYREMOVE(<массив>, <индекс>, <измерение>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<индекс> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER задаёт логическую позицию вставки либо удаления. |
<измерение> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER выбирает измерение от 1 до ранга включительно. ROW равно 1, COLUMN равно 2. Для преобразований массива ранга 2 и выше этот аргумент обязателен. |
Результат. Для одномерного массива функция возвращает элемент его типа. Для массива ранга 2 или выше функция возвращает массив с тем же типом элементов и рангом на единицу меньше.
Описание ARRAYREMOVE: поведение, ограничения и примеры
Запускаемые примеры
ARRAYRESHAPE
ARRAYRESHAPE копирует последовательность элементов в новую форму, заданную массивом образца.
Синтаксис, аргументы и результат
ARRAYRESHAPE(<источник>, <образец>)| Аргумент | Что передать |
|---|---|
<источник> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Выделенный массив задаёт последовательность переносимых элементов. |
<образец> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Выделенный массив того же типа элементов задаёт ранг и границы результата; его элементы не читаются. |
Результат. Функция возвращает массив с типом элементов исходного массива и рангом и границами массива-образца.
Описание ARRAYRESHAPE: поведение, ограничения и примеры
Запускаемые примеры
ARRAYREVERSE
ARRAYREVERSE меняет порядок элементов исходного массива на обратный.
Синтаксис, аргументы и результат
ARRAYREVERSE(<массив>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
Результат. Функция выполняет действие и не возвращает значение. Используйте вызов как отдельную инструкцию.
ARRAYREVERSE(<массив>, <измерение>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<измерение> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER выбирает измерение от 1 до ранга включительно. ROW равно 1, COLUMN равно 2. Для преобразований массива ранга 2 и выше этот аргумент обязателен. |
Результат. Функция выполняет действие и не возвращает значение. Используйте вызов как отдельную инструкцию.
Описание ARRAYREVERSE: поведение, ограничения и примеры
Запускаемые примеры
ARRAYSKIP
ARRAYSKIP копирует остаток массива после пропуска указанного количества.
Синтаксис, аргументы и результат
ARRAYSKIP(<массив>, <количество>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<количество> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER задаёт число элементов или срезов вдоль выбранного измерения. |
Результат. Функция возвращает массив с типом элементов исходного массива. Правила сохранения или изменения границ описаны в тематической статье этой функции.
ARRAYSKIP(<массив>, <количество>, <измерение>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<количество> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER задаёт число элементов или срезов вдоль выбранного измерения. |
<измерение> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER выбирает измерение от 1 до ранга включительно. ROW равно 1, COLUMN равно 2. Для преобразований массива ранга 2 и выше этот аргумент обязателен. |
Результат. Функция возвращает массив с типом элементов исходного массива. Правила сохранения или изменения границ описаны в тематической статье этой функции.
Описание ARRAYSKIP: поведение, ограничения и примеры
Запускаемые примеры
ARRAYSLICE
ARRAYSLICE копирует непрерывный диапазон элементов либо срезов массива.
Синтаксис, аргументы и результат
ARRAYSLICE(<массив>, <начальная позиция>, <количество>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<начальная позиция> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER задаёт первый логический индекс копируемого диапазона. |
<количество> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER задаёт число элементов или срезов вдоль выбранного измерения. |
Результат. Функция возвращает массив с типом элементов исходного массива. Правила сохранения или изменения границ описаны в тематической статье этой функции.
ARRAYSLICE(<массив>, <начальная позиция>, <количество>, <измерение>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<начальная позиция> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER задаёт первый логический индекс копируемого диапазона. |
<количество> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER задаёт число элементов или срезов вдоль выбранного измерения. |
<измерение> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER выбирает измерение от 1 до ранга включительно. ROW равно 1, COLUMN равно 2. Для преобразований массива ранга 2 и выше этот аргумент обязателен. |
Результат. Функция возвращает массив с типом элементов исходного массива. Правила сохранения или изменения границ описаны в тематической статье этой функции.
Описание ARRAYSLICE: поведение, ограничения и примеры
Запускаемые примеры
ARRAYSOME
ARRAYSOME проверяет, удовлетворяет ли хотя бы один элемент пользовательскому условию.
Синтаксис, аргументы и результат
ARRAYSOME(<массив>, <функция проверки>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<функция проверки> | Передаётся пользовательская функция с подписью FUNCTION(T) AS BOOLEAN. Значение функции принимает элемент и возвращает BOOLEAN; TRUE означает выполнение условия. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание ARRAYSOME: поведение, ограничения и примеры
Запускаемые примеры
ARRAYSORT
ARRAYSORT сортирует элементы исходного массива по возрастанию.
Синтаксис, аргументы и результат
ARRAYSORT(<массив>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
Результат. Функция выполняет действие и не возвращает значение. Используйте вызов как отдельную инструкцию.
ARRAYSORT(<массив>, <измерение>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<измерение> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER выбирает измерение от 1 до ранга включительно. ROW равно 1, COLUMN равно 2. Для преобразований массива ранга 2 и выше этот аргумент обязателен. |
Результат. Функция выполняет действие и не возвращает значение. Используйте вызов как отдельную инструкцию.
ARRAYSORT(<массив>, <field>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<field> | Значение аргумента должно быть строкой типа STRING. Строковая константа называет поле записи TYPE, по которому упорядочиваются записи. Принимается непосредственный литерал и строковая константа CONST, значение которой известно до выполнения; вычисляемое строковое выражение не подходит, а круглые скобки вокруг литерала контекст не прерывают. Форма с полем принимает только одномерный массив записей. Имя поля проверяется при разборе программы, поэтому опечатка отклоняется до запуска. Поле должно быть числовым, строковым или временным; массивное поле не упорядочивается. |
Результат. Функция выполняет действие и не возвращает значение. Используйте вызов как отдельную инструкцию.
ARRAYSORT(<массив>, <field>, <direction>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<field> | Значение аргумента должно быть строкой типа STRING. Строковая константа называет поле записи TYPE, по которому упорядочиваются записи. Принимается непосредственный литерал и строковая константа CONST, значение которой известно до выполнения; вычисляемое строковое выражение не подходит, а круглые скобки вокруг литерала контекст не прерывают. Форма с полем принимает только одномерный массив записей. Имя поля проверяется при разборе программы, поэтому опечатка отклоняется до запуска. Поле должно быть числовым, строковым или временным; массивное поле не упорядочивается. |
<direction> | Значение аргумента должно быть целым числом типа INTEGER. Необязательное направление сортировки по полю. Отсутствие этого аргумента и STEP 1 дают возрастание, STEP -1 даёт убывание. Другие значения отклоняются при разборе программы. |
Результат. Функция выполняет действие и не возвращает значение. Используйте вызов как отдельную инструкцию.
Описание ARRAYSORT: поведение, ограничения и примеры
Запускаемые примеры
ARRAYSUM
ARRAYSUM возвращает сумму числовых элементов массива.
Синтаксис, аргументы и результат
ARRAYSUM(<массив>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
Результат. Функция возвращает значение того же типа, что и элементы исходного массива.
Описание ARRAYSUM: поведение, ограничения и примеры
Запускаемые примеры
ARRAYTAKE
ARRAYTAKE копирует начальную часть массива по указанному количеству.
Синтаксис, аргументы и результат
ARRAYTAKE(<массив>, <количество>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<количество> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER задаёт число элементов или срезов вдоль выбранного измерения. |
Результат. Функция возвращает массив с типом элементов исходного массива. Правила сохранения или изменения границ описаны в тематической статье этой функции.
ARRAYTAKE(<массив>, <количество>, <измерение>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<количество> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER задаёт число элементов или срезов вдоль выбранного измерения. |
<измерение> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER выбирает измерение от 1 до ранга включительно. ROW равно 1, COLUMN равно 2. Для преобразований массива ранга 2 и выше этот аргумент обязателен. |
Результат. Функция возвращает массив с типом элементов исходного массива. Правила сохранения или изменения границ описаны в тематической статье этой функции.
Описание ARRAYTAKE: поведение, ограничения и примеры
Запускаемые примеры
ARRAYTOREVERSED
ARRAYTOREVERSED возвращает копию с обратным порядком элементов.
Синтаксис, аргументы и результат
ARRAYTOREVERSED(<массив>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
Результат. Функция возвращает массив с типом элементов исходного массива. Правила сохранения или изменения границ описаны в тематической статье этой функции.
ARRAYTOREVERSED(<массив>, <измерение>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<измерение> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER выбирает измерение от 1 до ранга включительно. ROW равно 1, COLUMN равно 2. Для преобразований массива ранга 2 и выше этот аргумент обязателен. |
Результат. Функция возвращает массив с типом элементов исходного массива. Правила сохранения или изменения границ описаны в тематической статье этой функции.
Описание ARRAYTOREVERSED: поведение, ограничения и примеры
Запускаемые примеры
ARRAYTOSORTED
ARRAYTOSORTED возвращает отсортированную копию массива.
Синтаксис, аргументы и результат
ARRAYTOSORTED(<массив>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
Результат. Функция возвращает массив с типом элементов исходного массива. Правила сохранения или изменения границ описаны в тематической статье этой функции.
ARRAYTOSORTED(<массив>, <измерение>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<измерение> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER выбирает измерение от 1 до ранга включительно. ROW равно 1, COLUMN равно 2. Для преобразований массива ранга 2 и выше этот аргумент обязателен. |
Результат. Функция возвращает массив с типом элементов исходного массива. Правила сохранения или изменения границ описаны в тематической статье этой функции.
ARRAYTOSORTED(<массив>, <field>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<field> | Значение аргумента должно быть строкой типа STRING. Строковая константа называет поле записи TYPE, по которому упорядочиваются записи. Принимается непосредственный литерал и строковая константа CONST, значение которой известно до выполнения; вычисляемое строковое выражение не подходит, а круглые скобки вокруг литерала контекст не прерывают. Форма с полем принимает только одномерный массив записей. Имя поля проверяется при разборе программы, поэтому опечатка отклоняется до запуска. Поле должно быть числовым, строковым или временным; массивное поле не упорядочивается. |
Результат. Функция возвращает массив с типом элементов исходного массива. Правила сохранения или изменения границ описаны в тематической статье этой функции.
ARRAYTOSORTED(<массив>, <field>, <direction>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<field> | Значение аргумента должно быть строкой типа STRING. Строковая константа называет поле записи TYPE, по которому упорядочиваются записи. Принимается непосредственный литерал и строковая константа CONST, значение которой известно до выполнения; вычисляемое строковое выражение не подходит, а круглые скобки вокруг литерала контекст не прерывают. Форма с полем принимает только одномерный массив записей. Имя поля проверяется при разборе программы, поэтому опечатка отклоняется до запуска. Поле должно быть числовым, строковым или временным; массивное поле не упорядочивается. |
<direction> | Значение аргумента должно быть целым числом типа INTEGER. Необязательное направление сортировки по полю. Отсутствие этого аргумента и STEP 1 дают возрастание, STEP -1 даёт убывание. Другие значения отклоняются при разборе программы. |
Результат. Функция возвращает массив с типом элементов исходного массива. Правила сохранения или изменения границ описаны в тематической статье этой функции.
Описание ARRAYTOSORTED: поведение, ограничения и примеры
Запускаемые примеры
ASC
ASC возвращает код первого символа строки в CP866, если он представлен в этой таблице, иначе его Unicode-код.
Синтаксис, аргументы и результат
ASC(<текст>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте непустую строку, код первого целого Unicode-символа которой требуется получить; остальные символы не участвуют в результате. |
Результат. Функция возвращает целое число типа INTEGER.
Описание ASC: поведение, ограничения и примеры
Запускаемые примеры
ASCW
ASCW возвращает Unicode-код первого символа строки без преобразования через CP866.
Синтаксис, аргументы и результат
ASCW(<текст>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте непустую строку, Unicode-код первого целого символа которой требуется получить. |
Результат. Функция возвращает целое число типа INTEGER.
Описание ASCW: поведение, ограничения и примеры
Запускаемые примеры
ASIN
ASIN возвращает арксинус числа.
Синтаксис, аргументы и результат
ASIN(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Перед вычислением оно преобразуется в DOUBLE. Передайте значение синуса в диапазоне от -1 до 1 включительно. |
Результат. Функция возвращает число типа DOUBLE.
Описание ASIN: поведение, ограничения и примеры
Запускаемые примеры
ASINH
ASINH возвращает обратный гиперболический синус числа.
Синтаксис, аргументы и результат
ASINH(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Перед вычислением оно преобразуется в DOUBLE. Передайте число, для которого требуется вычислить обратный гиперболический синус. |
Результат. Функция возвращает число типа DOUBLE.
Описание ASINH: поведение, ограничения и примеры
Запускаемые примеры
ATANH
ATANH возвращает обратный гиперболический тангенс числа.
Синтаксис, аргументы и результат
ATANH(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Перед вычислением оно преобразуется в DOUBLE. Передайте число строго между -1 и 1; граничные значения не допускаются. |
Результат. Функция возвращает число типа DOUBLE.
Описание ATANH: поведение, ограничения и примеры
Запускаемые примеры
ATN
ATN возвращает арктангенс числа.
Синтаксис, аргументы и результат
ATN(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Перед вычислением оно преобразуется в DOUBLE. Передайте значение тангенса, по которому требуется определить угол. |
Результат. Функция возвращает число типа DOUBLE.
Описание ATN: поведение, ограничения и примеры
Запускаемые примеры
ATN2
ATN2 возвращает угол направления точки относительно положительной оси x.
Синтаксис, аргументы и результат
ATN2(<y>, <x>)| Аргумент | Что передать |
|---|---|
<y> | Передаётся числовое выражение. Перед вычислением оно преобразуется в DOUBLE. Передайте вертикальную координату точки, направление на которую нужно определить. |
<x> | Передаётся числовое выражение. Перед вычислением оно преобразуется в DOUBLE. Передайте горизонтальную координату той же точки; вместе со знаком y она определяет квадрант угла. |
Результат. Функция возвращает число типа DOUBLE.
Описание ATN2: поведение, ограничения и примеры
Запускаемые примеры
CBRT
CBRT возвращает кубический корень числа.
Синтаксис, аргументы и результат
CBRT(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Перед вычислением оно преобразуется в DOUBLE. Передайте число, кубический корень которого требуется вычислить. |
Результат. Функция возвращает число типа DOUBLE.
Описание CBRT: поведение, ограничения и примеры
Запускаемые примеры
CDBL
CDBL возвращает число, преобразованное в DOUBLE.
Синтаксис, аргументы и результат
CDBL(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Допустимые числовые типы и результат описаны ниже. Передайте число, которое нужно представить в двоичном виде DOUBLE; большое целое или DECIMAL может потерять часть точности. |
Результат. Функция возвращает число типа DOUBLE.
Описание CDBL: поведение, ограничения и примеры
Запускаемые примеры
CDEC
CDEC возвращает число, преобразованное в DECIMAL.
Синтаксис, аргументы и результат
CDEC(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Допустимые числовые типы и результат описаны ниже. Передайте число, которое нужно представить как DECIMAL; результат должен помещаться в диапазон этого типа. |
Результат. Функция возвращает десятичное число типа DECIMAL.
Описание CDEC: поведение, ограничения и примеры
Запускаемые примеры
CEIL
CEIL возвращает наименьшее целое значение, не меньшее аргумента.
Синтаксис, аргументы и результат
CEIL(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Допустимые числовые типы и результат описаны ниже. Передайте число, которое требуется округлить вверх. |
Результат. Функция возвращает значение того же числового типа, что и первый аргумент.
Описание CEIL: поведение, ограничения и примеры
Запускаемые примеры
CENTER
CENTER возвращает строку, дополнив её с обеих сторон до заданной ширины.
Синтаксис, аргументы и результат
CENTER(<текст>, <ширина>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<ширина> | Значение аргумента должно быть целым числом типа INTEGER. Передайте неотрицательное целое число типа INTEGER с минимальной длиной результата в кодовых единицах UTF-16. |
Результат. Функция возвращает строку типа STRING.
CENTER(<текст>, <ширина>, <заполнение>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<ширина> | Значение аргумента должно быть целым числом типа INTEGER. Передайте неотрицательное целое число типа INTEGER с минимальной длиной результата в кодовых единицах UTF-16. |
<заполнение> | Значение аргумента должно быть строкой типа STRING. Передайте непустую строку типа STRING с заполнителем. Используется первая кодовая единица UTF-16; без аргумента используется обычный пробел. |
Результат. Функция возвращает строку типа STRING.
Описание CENTER: поведение, ограничения и примеры
Запускаемые примеры
CHANGEDIR
CHANGEDIR меняет рабочую папку текущего запуска.
Синтаксис, аргументы и результат
CHANGEDIR(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к каталогу. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание CHANGEDIR: поведение, ограничения и примеры
Запускаемые примеры
CHR
CHR создаёт строку с символом по коду CP866 для значений 0–255 или по Unicode-коду для больших значений.
Синтаксис, аргументы и результат
CHR(<код>)| Аргумент | Что передать |
|---|---|
<код> | Значение аргумента должно быть целым числом типа INTEGER. Укажите код от 0 до 1114111, исключая суррогатный диапазон 55296–57343; значения 0–255 выбирают символ из CP866. |
Результат. Функция возвращает строку типа STRING.
Описание CHR: поведение, ограничения и примеры
Запускаемые примеры
CHRW
CHRW создаёт строку с символом по Unicode-коду без подмены младшего диапазона таблицей CP866.
Синтаксис, аргументы и результат
CHRW(<код>)| Аргумент | Что передать |
|---|---|
<код> | Значение аргумента должно быть целым числом типа INTEGER. Укажите Unicode-код от 0 до 1114111, исключая суррогатный диапазон 55296–57343. |
Результат. Функция возвращает строку типа STRING.
Описание CHRW: поведение, ограничения и примеры
Запускаемые примеры
CINT
CINT возвращает целую часть числа в типе INTEGER.
Синтаксис, аргументы и результат
CINT(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Допустимые числовые типы и результат описаны ниже. Передайте число, усечённый результат которого должен помещаться в диапазон INTEGER. |
Результат. Функция возвращает целое число типа INTEGER.
Описание CINT: поведение, ограничения и примеры
Запускаемые примеры
CLAMP
CLAMP возвращает число, ограниченное заданным включительным диапазоном.
Синтаксис, аргументы и результат
CLAMP(<значение>, <нижняя граница>, <верхняя граница>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Допустимые числовые типы и результат описаны ниже. Передайте число, которое требуется ограничить диапазоном. |
<нижняя граница> | Передаётся числовое выражение. Допустимые числовые типы и результат описаны ниже. Укажите включённую нижнюю границу диапазона; она не должна превышать верхнюю. |
<верхняя граница> | Передаётся числовое выражение. Допустимые числовые типы и результат описаны ниже. Укажите включённую верхнюю границу диапазона. |
Результат. Функция возвращает значение общего числового типа своих аргументов.
Описание CLAMP: поведение, ограничения и примеры
Запускаемые примеры
CLNG
CLNG возвращает целую часть числа в типе LONG.
Синтаксис, аргументы и результат
CLNG(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Допустимые числовые типы и результат описаны ниже. Передайте число, усечённый результат которого должен помещаться в диапазон LONG. |
Результат. Функция возвращает целое число типа LONG.
Описание CLNG: поведение, ограничения и примеры
Запускаемые примеры
COMBINEPATH
COMBINEPATH соединяет две строковые части пути.
Синтаксис, аргументы и результат
COMBINEPATH(<левый операнд>, <правый операнд>)| Аргумент | Что передать |
|---|---|
<левый операнд> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка левой части задаёт начало составляемого пути. |
<правый операнд> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка правой части задаёт присоединяемый путь; абсолютная правая часть заменяет левую. |
Результат. Функция возвращает строку типа STRING.
Описание COMBINEPATH: поведение, ограничения и примеры
Запускаемые примеры
CONTAINS
CONTAINS проверяет, содержит ли строка указанный фрагмент.
Синтаксис, аргументы и результат
CONTAINS(<текст>, <фрагмент>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<фрагмент> | Значение аргумента должно быть строкой типа STRING. Передайте строку типа STRING, которую требуется найти в исходном тексте. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание CONTAINS: поведение, ограничения и примеры
Запускаемые примеры
COPYDIR
COPYDIR копирует дерево обычных файлов и каталогов.
Синтаксис, аргументы и результат
COPYDIR(<источник>, <назначение>)| Аргумент | Что передать |
|---|---|
<источник> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка источника задаёт существующий каталог для переноса либо копирования. |
<назначение> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка назначения задаёт полный путь каталога назначения, включая его имя. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
COPYDIR(<источник>, <назначение>, <разрешение перезаписи>)| Аргумент | Что передать |
|---|---|
<источник> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка источника задаёт существующий каталог для переноса либо копирования. |
<назначение> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка назначения задаёт полный путь каталога назначения, включая его имя. |
<разрешение перезаписи> | Значение аргумента должно быть логическим значением типа BOOLEAN. имеет тип BOOLEAN. Логическое значение TRUE разрешает замену существующих файлов; FALSE запрещает её. Без этого аргумента действует FALSE. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание COPYDIR: поведение, ограничения и примеры
Запускаемые примеры
COPYFILE
COPYFILE копирует содержимое существующего файла в другой файл.
Синтаксис, аргументы и результат
COPYFILE(<источник>, <назначение>)| Аргумент | Что передать |
|---|---|
<источник> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка источника задаёт существующий файл для переноса либо копирования. |
<назначение> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка назначения задаёт полный путь файла назначения, включая его имя. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
COPYFILE(<источник>, <назначение>, <разрешение перезаписи>)| Аргумент | Что передать |
|---|---|
<источник> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка источника задаёт существующий файл для переноса либо копирования. |
<назначение> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка назначения задаёт полный путь файла назначения, включая его имя. |
<разрешение перезаписи> | Значение аргумента должно быть логическим значением типа BOOLEAN. имеет тип BOOLEAN. Логическое значение TRUE разрешает замену существующих файлов; FALSE запрещает её. Без этого аргумента действует FALSE. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание COPYFILE: поведение, ограничения и примеры
Запускаемые примеры
COS
COS возвращает косинус угла.
Синтаксис, аргументы и результат
COS(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Перед вычислением оно преобразуется в DOUBLE. Передайте угол в радианах, косинус которого требуется вычислить. |
Результат. Функция возвращает число типа DOUBLE.
Описание COS: поведение, ограничения и примеры
Запускаемые примеры
COSH
COSH возвращает гиперболический косинус числа.
Синтаксис, аргументы и результат
COSH(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Перед вычислением оно преобразуется в DOUBLE. Передайте число, для которого требуется вычислить гиперболический косинус. |
Результат. Функция возвращает число типа DOUBLE.
Описание COSH: поведение, ограничения и примеры
Запускаемые примеры
CURRENTDIR
CURRENTDIR возвращает полный путь рабочей папки текущего запуска.
Синтаксис, аргументы и результат
CURRENTDIR()Функция вызывается без аргументов.
Результат. Функция возвращает строку типа STRING.
Описание CURRENTDIR: поведение, ограничения и примеры
Запускаемые примеры
DATE
DATE возвращает текущую календарную дату.
Синтаксис, аргументы и результат
DATE()Функция вызывается без аргументов.
Результат. Функция возвращает дату типа DATE.
DATE(<часовой пояс>)| Аргумент | Что передать |
|---|---|
<часовой пояс> | Значение аргумента должно быть строкой типа STRING. Укажите строковый идентификатор часового пояса, в котором нужно определить текущую дату; без аргумента используется местный пояс. |
Результат. Функция возвращает дату типа DATE.
Описание DATE: поведение, ограничения и примеры
Запускаемые примеры
DATEADD
DATEADD возвращает дату или время после прибавления указанного числа интервалов.
Синтаксис, аргументы и результат
DATEADD(<интервал>, <число>, <значение>)| Аргумент | Что передать |
|---|---|
<интервал> | Значение аргумента должно быть строкой типа STRING. Укажите единицу сдвига: yyyy, q, m или d для календаря либо h, n или s для времени. |
<число> | Значение аргумента должно быть целым числом типа INTEGER. Укажите число интервалов для прибавления; отрицательное значение выполняет сдвиг назад. |
<значение> | Значение аргумента должно быть датой типа DATE. Передайте исходное значение DATE, TIME или DATETIME, совместимое с выбранным интервалом; строковая форма здесь не поддерживается. |
Результат. Функция возвращает дату типа DATE.
DATEADD(<интервал>, <число>, <значение>)| Аргумент | Что передать |
|---|---|
<интервал> | Значение аргумента должно быть строкой типа STRING. Укажите единицу сдвига: yyyy, q, m или d для календаря либо h, n или s для времени. |
<число> | Значение аргумента должно быть целым числом типа INTEGER. Укажите число интервалов для прибавления; отрицательное значение выполняет сдвиг назад. |
<значение> | Значение аргумента должно быть временем суток типа TIME. Передайте исходное значение DATE, TIME или DATETIME, совместимое с выбранным интервалом; строковая форма здесь не поддерживается. |
Результат. Функция возвращает время суток типа TIME.
DATEADD(<интервал>, <число>, <значение>)| Аргумент | Что передать |
|---|---|
<интервал> | Значение аргумента должно быть строкой типа STRING. Укажите единицу сдвига: yyyy, q, m или d для календаря либо h, n или s для времени. |
<число> | Значение аргумента должно быть целым числом типа INTEGER. Укажите число интервалов для прибавления; отрицательное значение выполняет сдвиг назад. |
<значение> | Значение аргумента должно быть датой и временем типа DATETIME. Передайте исходное значение DATE, TIME или DATETIME, совместимое с выбранным интервалом; строковая форма здесь не поддерживается. |
Результат. Функция возвращает дату и время типа DATETIME.
Описание DATEADD: поведение, ограничения и примеры
Запускаемые примеры
DATEDIFF
DATEDIFF возвращает число пересечённых границ указанного интервала между двумя значениями.
Синтаксис, аргументы и результат
DATEDIFF(<интервал>, <начальное значение>, <конечное значение>)| Аргумент | Что передать |
|---|---|
<интервал> | Значение аргумента должно быть строкой типа STRING. Укажите единицу разности: yyyy, q, m или d для календаря либо h, n или s для времени. |
<начальное значение> | Значение аргумента должно быть датой типа DATE. Передайте начальное временное значение, от которого вычисляется разность. |
<конечное значение> | Значение аргумента должно быть датой типа DATE. Передайте конечное временное значение того же вида, что и начальное; оба значения должны соответствовать выбранному интервалу. |
Результат. Функция возвращает целое число типа LONG.
DATEDIFF(<интервал>, <начальное значение>, <конечное значение>)| Аргумент | Что передать |
|---|---|
<интервал> | Значение аргумента должно быть строкой типа STRING. Укажите единицу разности: yyyy, q, m или d для календаря либо h, n или s для времени. |
<начальное значение> | Значение аргумента должно быть временем суток типа TIME. Передайте начальное временное значение, от которого вычисляется разность. |
<конечное значение> | Значение аргумента должно быть временем суток типа TIME. Передайте конечное временное значение того же вида, что и начальное; оба значения должны соответствовать выбранному интервалу. |
Результат. Функция возвращает целое число типа LONG.
DATEDIFF(<интервал>, <начальное значение>, <конечное значение>)| Аргумент | Что передать |
|---|---|
<интервал> | Значение аргумента должно быть строкой типа STRING. Укажите единицу разности: yyyy, q, m или d для календаря либо h, n или s для времени. |
<начальное значение> | Значение аргумента должно быть датой и временем типа DATETIME. Передайте начальное временное значение, от которого вычисляется разность. |
<конечное значение> | Значение аргумента должно быть датой и временем типа DATETIME. Передайте конечное временное значение того же вида, что и начальное; оба значения должны соответствовать выбранному интервалу. |
Результат. Функция возвращает целое число типа LONG.
Описание DATEDIFF: поведение, ограничения и примеры
Запускаемые примеры
DATEPART
DATEPART возвращает выбранную календарную или временную часть значения.
Синтаксис, аргументы и результат
DATEPART(<часть>, <значение>)| Аргумент | Что передать |
|---|---|
<часть> | Значение аргумента должно быть строкой типа STRING. Укажите токен нужной части: yyyy, q, m, d, y или w для календаря либо h, n или s для времени. |
<значение> | Значение аргумента должно быть датой типа DATE. Передайте DATE, TIME или DATETIME, содержащее выбранную часть; строковая форма здесь не поддерживается. |
Результат. Функция возвращает целое число типа INTEGER.
DATEPART(<часть>, <значение>)| Аргумент | Что передать |
|---|---|
<часть> | Значение аргумента должно быть строкой типа STRING. Укажите токен нужной части: yyyy, q, m, d, y или w для календаря либо h, n или s для времени. |
<значение> | Значение аргумента должно быть временем суток типа TIME. Передайте DATE, TIME или DATETIME, содержащее выбранную часть; строковая форма здесь не поддерживается. |
Результат. Функция возвращает целое число типа INTEGER.
DATEPART(<часть>, <значение>)| Аргумент | Что передать |
|---|---|
<часть> | Значение аргумента должно быть строкой типа STRING. Укажите токен нужной части: yyyy, q, m, d, y или w для календаря либо h, n или s для времени. |
<значение> | Значение аргумента должно быть датой и временем типа DATETIME. Передайте DATE, TIME или DATETIME, содержащее выбранную часть; строковая форма здесь не поддерживается. |
Результат. Функция возвращает целое число типа INTEGER.
Описание DATEPART: поведение, ограничения и примеры
Запускаемые примеры
DATESERIAL
DATESERIAL возвращает дату, собранную из года, месяца и дня.
Синтаксис, аргументы и результат
DATESERIAL(<год>, <месяц>, <день>)| Аргумент | Что передать |
|---|---|
<год> | Значение аргумента должно быть целым числом типа INTEGER. Укажите год от 1 до 9999; годы 1–99 сохраняют свой буквальный номер. |
<месяц> | Значение аргумента должно быть целым числом типа INTEGER. Укажите номер месяца от 1 до 12. |
<день> | Значение аргумента должно быть целым числом типа INTEGER. Укажите день от 1 до числа дней выбранного месяца и года. |
Результат. Функция возвращает дату типа DATE.
Описание DATESERIAL: поведение, ограничения и примеры
Запускаемые примеры
DATETIMESERIAL
DATETIMESERIAL возвращает дату и время, собранные из готовых значений DATE и TIME.
Синтаксис, аргументы и результат
DATETIMESERIAL(<date>, <time>)| Аргумент | Что передать |
|---|---|
<date> | Значение аргумента должно быть датой типа DATE. Передайте значение DATE, календарную дату которого нужно взять целиком. |
<time> | Значение аргумента должно быть временем суток типа TIME. Передайте значение TIME, время суток которого нужно взять целиком вместе с долями секунды. |
Результат. Функция возвращает дату и время типа DATETIME.
Описание DATETIMESERIAL: поведение, ограничения и примеры
Запускаемые примеры
DATETIMEVALUE
DATETIMEVALUE возвращает дату и время, прочитанные из строки в канонической записи или в формате обмена.
Синтаксис, аргументы и результат
DATETIMEVALUE(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть строкой типа STRING. Передайте строку вида yyyy-MM-dd HH:mm:ss или yyyy-MM-ddTHH:mm:ss. Допускается дробная часть секунд. Смещение вида +03:00 и суффикс Z не принимаются: значение DATETIME не хранит часовой пояс. |
Результат. Функция возвращает дату и время типа DATETIME.
Описание DATETIMEVALUE: поведение, ограничения и примеры
Запускаемые примеры
DATEVALUE
DATEVALUE возвращает календарную дату, прочитанную из строки или взятую из значения DATETIME.
Синтаксис, аргументы и результат
DATEVALUE(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть строкой типа STRING. Передайте строку вида yyyy-MM-dd или yyyy-MM-dd HH:mm:ss либо значение DATETIME. Допускается дробная часть секунд. Результат содержит только календарную дату, поэтому время суток в него не входит. |
Результат. Функция возвращает дату типа DATE.
DATEVALUE(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть датой и временем типа DATETIME. Передайте строку вида yyyy-MM-dd или yyyy-MM-dd HH:mm:ss либо значение DATETIME. Допускается дробная часть секунд. Результат содержит только календарную дату, поэтому время суток в него не входит. |
Результат. Функция возвращает дату типа DATE.
Описание DATEVALUE: поведение, ограничения и примеры
Запускаемые примеры
DAY
DAY возвращает номер дня внутри месяца.
Синтаксис, аргументы и результат
DAY(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть датой типа DATE. Передайте календарное значение или его поддержанную каноническую строковую запись, из которой нужно получить день месяца. |
Результат. Функция возвращает целое число типа INTEGER.
Описание DAY: поведение, ограничения и примеры
Запускаемые примеры
DAYSINMONTH
DAYSINMONTH возвращает количество дней в месяце.
Синтаксис, аргументы и результат
DAYSINMONTH(<год>, <месяц>)| Аргумент | Что передать |
|---|---|
<год> | Значение аргумента должно быть целым числом типа INTEGER. Укажите год от 1 до 9999, чтобы учесть в том числе високосный февраль. |
<месяц> | Значение аргумента должно быть целым числом типа INTEGER. Укажите номер месяца от 1 до 12, длительность которого требуется определить. |
Результат. Функция возвращает целое число типа INTEGER.
Описание DAYSINMONTH: поведение, ограничения и примеры
Запускаемые примеры
DELETEDIR
DELETEDIR удаляет пустой каталог.
Синтаксис, аргументы и результат
DELETEDIR(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к каталогу. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание DELETEDIR: поведение, ограничения и примеры
Запускаемые примеры
DELETEDIRRECURSIVE
DELETEDIRRECURSIVE удаляет каталог со всем его содержимым.
Синтаксис, аргументы и результат
DELETEDIRRECURSIVE(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к каталогу. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание DELETEDIRRECURSIVE: поведение, ограничения и примеры
Запускаемые примеры
DELETEFILE
DELETEFILE удаляет файл по заданному пути.
Синтаксис, аргументы и результат
DELETEFILE(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к файлу. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание DELETEFILE: поведение, ограничения и примеры
Запускаемые примеры
DIRDATE
DIRDATE возвращает местные дату и время последней записи в каталог.
Синтаксис, аргументы и результат
DIRDATE(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к каталогу. |
Результат. Функция возвращает строку типа STRING.
Описание DIRDATE: поведение, ограничения и примеры
Запускаемые примеры
DIRDATEUTC
DIRDATEUTC возвращает момент последнего изменения каталога на шкале UTC.
Синтаксис, аргументы и результат
DIRDATEUTC(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. Передайте путь к существующему объекту; для файловых форм это файл, для DIRDATEUTC — каталог. |
Результат. Функция возвращает момент времени типа UTCDATETIME.
Описание DIRDATEUTC: поведение, ограничения и примеры
Запускаемые примеры
DIREXISTS
DIREXISTS проверяет, существует ли каталог по заданному пути.
Синтаксис, аргументы и результат
DIREXISTS(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к каталогу. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание DIREXISTS: поведение, ограничения и примеры
Запускаемые примеры
DIRNAME
DIRNAME возвращает полный путь родительского каталога.
Синтаксис, аргументы и результат
DIRNAME(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт строку пути, которую нужно разобрать или нормализовать. |
Результат. Функция возвращает строку типа STRING.
Описание DIRNAME: поведение, ограничения и примеры
Запускаемые примеры
DIRSIZE
DIRSIZE возвращает суммарный размер обычных файлов дерева каталога в байтах.
Синтаксис, аргументы и результат
DIRSIZE(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к каталогу. |
Результат. Функция возвращает целое число типа LONG.
Описание DIRSIZE: поведение, ограничения и примеры
Запускаемые примеры
DRIVEFORMAT
DRIVEFORMAT возвращает имя файловой системы диска.
Синтаксис, аргументы и результат
DRIVEFORMAT(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь, по корню которого выбирается диск. |
Результат. Функция возвращает строку типа STRING.
Описание DRIVEFORMAT: поведение, ограничения и примеры
Запускаемые примеры
DRIVENAME
DRIVENAME возвращает строковое имя корня диска.
Синтаксис, аргументы и результат
DRIVENAME(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь, по корню которого выбирается диск. |
Результат. Функция возвращает строку типа STRING.
Описание DRIVENAME: поведение, ограничения и примеры
Запускаемые примеры
DRIVETYPE
DRIVETYPE возвращает строковое название типа диска.
Синтаксис, аргументы и результат
DRIVETYPE(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь, по корню которого выбирается диск. |
Результат. Функция возвращает строку типа STRING.
Описание DRIVETYPE: поведение, ограничения и примеры
Запускаемые примеры
ELAPSEDSECONDS
ELAPSEDSECONDS возвращает прошедшее время в секундах: от начала запуска либо между двумя моментами.
Синтаксис, аргументы и результат
ELAPSEDSECONDS()Функция вызывается без аргументов.
Результат. Функция возвращает число типа DOUBLE.
ELAPSEDSECONDS(<начальное значение>, <конечное значение>)| Аргумент | Что передать |
|---|---|
<начальное значение> | Значение аргумента должно быть моментом времени типа UTCDATETIME. Передайте начальный момент времени типа UTCDATETIME. |
<конечное значение> | Значение аргумента должно быть моментом времени типа UTCDATETIME. Передайте конечный момент времени типа UTCDATETIME. Если он раньше начального, результат отрицательный. |
Результат. Функция возвращает число типа DOUBLE.
Описание ELAPSEDSECONDS: поведение, ограничения и примеры
Запускаемые примеры
ENDOFMONTH
ENDOFMONTH возвращает последний день месяца исходной даты.
Синтаксис, аргументы и результат
ENDOFMONTH(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть датой типа DATE. Передайте дату или поддержанное календарное значение, месяц которого нужно завершить. |
Результат. Функция возвращает дату типа DATE.
Описание ENDOFMONTH: поведение, ограничения и примеры
Запускаемые примеры
ENDOFYEAR
ENDOFYEAR возвращает последний день года исходной даты.
Синтаксис, аргументы и результат
ENDOFYEAR(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть датой типа DATE. Передайте дату или поддержанное календарное значение, год которого нужно завершить. |
Результат. Функция возвращает дату типа DATE.
Описание ENDOFYEAR: поведение, ограничения и примеры
Запускаемые примеры
ENDSWITH
ENDSWITH проверяет, заканчивается ли строка указанным фрагментом.
Синтаксис, аргументы и результат
ENDSWITH(<текст>, <фрагмент>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<фрагмент> | Значение аргумента должно быть строкой типа STRING. Передайте строку типа STRING, которую требуется найти в исходном тексте. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание ENDSWITH: поведение, ограничения и примеры
Запускаемые примеры
EOF
EOF проверяет, достигнута ли конечная байтовая позиция файла при чтении.
Синтаксис, аргументы и результат
EOF(<файл>)| Аргумент | Что передать |
|---|---|
<файл> | Значение аргумента должно быть значением открытого файла типа FILE. имеет тип FILE. Значение типа FILE обозначает ресурс, открытый оператором OPEN в режиме INPUT. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание EOF: поведение, ограничения и примеры
Запускаемые примеры
EXP
EXP возвращает значение экспоненты e в степени аргумента.
Синтаксис, аргументы и результат
EXP(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Перед вычислением оно преобразуется в DOUBLE. Передайте показатель степени, в которую нужно возвести число e. |
Результат. Функция возвращает число типа DOUBLE.
Описание EXP: поведение, ограничения и примеры
Запускаемые примеры
EXTNAME
EXTNAME возвращает расширение последнего компонента пути вместе с точкой.
Синтаксис, аргументы и результат
EXTNAME(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт строку пути, которую нужно разобрать или нормализовать. |
Результат. Функция возвращает строку типа STRING.
Описание EXTNAME: поведение, ограничения и примеры
Запускаемые примеры
FILEACCESSEDDATE
FILEACCESSEDDATE возвращает местные дату и время последнего доступа к файлу.
Синтаксис, аргументы и результат
FILEACCESSEDDATE(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к файлу. |
Результат. Функция возвращает строку типа STRING.
Описание FILEACCESSEDDATE: поведение, ограничения и примеры
Запускаемые примеры
FILEACCESSEDDATEUTC
FILEACCESSEDDATEUTC возвращает момент последнего доступа к файлу на шкале UTC.
Синтаксис, аргументы и результат
FILEACCESSEDDATEUTC(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. Передайте путь к существующему объекту; для файловых форм это файл, для DIRDATEUTC — каталог. |
Результат. Функция возвращает момент времени типа UTCDATETIME.
Описание FILEACCESSEDDATEUTC: поведение, ограничения и примеры
Запускаемые примеры
FILECREATEDATE
FILECREATEDATE возвращает местные дату и время создания файла.
Синтаксис, аргументы и результат
FILECREATEDATE(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к файлу. |
Результат. Функция возвращает строку типа STRING.
Описание FILECREATEDATE: поведение, ограничения и примеры
Запускаемые примеры
FILECREATEDATEUTC
FILECREATEDATEUTC возвращает момент создания файла на шкале UTC.
Синтаксис, аргументы и результат
FILECREATEDATEUTC(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. Передайте путь к существующему объекту; для файловых форм это файл, для DIRDATEUTC — каталог. |
Результат. Функция возвращает момент времени типа UTCDATETIME.
Описание FILECREATEDATEUTC: поведение, ограничения и примеры
Запускаемые примеры
FILEDATE
FILEDATE возвращает местные дату и время последней записи в файл.
Синтаксис, аргументы и результат
FILEDATE(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к файлу. |
Результат. Функция возвращает строку типа STRING.
Описание FILEDATE: поведение, ограничения и примеры
Запускаемые примеры
FILEDATEUTC
FILEDATEUTC возвращает момент последней записи в файл на шкале UTC.
Синтаксис, аргументы и результат
FILEDATEUTC(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. Передайте путь к существующему объекту; для файловых форм это файл, для DIRDATEUTC — каталог. |
Результат. Функция возвращает момент времени типа UTCDATETIME.
Описание FILEDATEUTC: поведение, ограничения и примеры
Запускаемые примеры
FILEEXISTS
FILEEXISTS проверяет, существует ли обычный файл по заданному пути.
Синтаксис, аргументы и результат
FILEEXISTS(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к файлу. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание FILEEXISTS: поведение, ограничения и примеры
Запускаемые примеры
FILELENGTH
FILELENGTH возвращает текущую длину содержимого открытого файла в байтах.
Синтаксис, аргументы и результат
FILELENGTH(<файл>)| Аргумент | Что передать |
|---|---|
<файл> | Значение аргумента должно быть значением открытого файла типа FILE. имеет тип FILE. Значение типа FILE обозначает ресурс, открытый оператором OPEN. |
Результат. Функция возвращает целое число типа LONG.
Описание FILELENGTH: поведение, ограничения и примеры
Запускаемые примеры
FILEMODE
FILEMODE возвращает строковое имя режима открытого ресурса FILE.
Синтаксис, аргументы и результат
FILEMODE(<файл>)| Аргумент | Что передать |
|---|---|
<файл> | Значение аргумента должно быть значением открытого файла типа FILE. имеет тип FILE. Значение типа FILE обозначает ресурс, открытый оператором OPEN. |
Результат. Функция возвращает строку типа STRING.
Описание FILEMODE: поведение, ограничения и примеры
Запускаемые примеры
FILENAME
FILENAME возвращает последнюю часть полного пути вместе с расширением.
Синтаксис, аргументы и результат
FILENAME(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт строку пути, которую нужно разобрать или нормализовать. |
Результат. Функция возвращает строку типа STRING.
Описание FILENAME: поведение, ограничения и примеры
Запускаемые примеры
FILEPATH
FILEPATH возвращает полный путь открытого ресурса FILE.
Синтаксис, аргументы и результат
FILEPATH(<файл>)| Аргумент | Что передать |
|---|---|
<файл> | Значение аргумента должно быть значением открытого файла типа FILE. имеет тип FILE. Значение типа FILE обозначает ресурс, открытый оператором OPEN. |
Результат. Функция возвращает строку типа STRING.
Описание FILEPATH: поведение, ограничения и примеры
Запускаемые примеры
FILEPOS
FILEPOS возвращает текущую байтовую позицию открытого файла.
Синтаксис, аргументы и результат
FILEPOS(<файл>)| Аргумент | Что передать |
|---|---|
<файл> | Значение аргумента должно быть значением открытого файла типа FILE. имеет тип FILE. Значение типа FILE обозначает ресурс, открытый оператором OPEN. |
Результат. Функция возвращает целое число типа LONG.
Описание FILEPOS: поведение, ограничения и примеры
Запускаемые примеры
FILESIZE
FILESIZE возвращает физическую длину файла в байтах.
Синтаксис, аргументы и результат
FILESIZE(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к файлу. |
Результат. Функция возвращает целое число типа LONG.
Описание FILESIZE: поведение, ограничения и примеры
Запускаемые примеры
FIX
FIX возвращает целую часть числа после удаления дробной части.
Синтаксис, аргументы и результат
FIX(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Допустимые числовые типы и результат описаны ниже. Передайте число, у которого нужно удалить дробную часть; например, для отрицательного числа результат приближается к нулю. |
Результат. Функция возвращает значение того же числового типа, что и первый аргумент.
Описание FIX: поведение, ограничения и примеры
Запускаемые примеры
FLOOR
FLOOR возвращает наибольшее целое значение, не превышающее аргумент.
Синтаксис, аргументы и результат
FLOOR(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Допустимые числовые типы и результат описаны ниже. Передайте число, для которого нужно найти наибольшее целое значение, не превышающее исходное число. |
Результат. Функция возвращает значение того же числового типа, что и первый аргумент.
Описание FLOOR: поведение, ограничения и примеры
Запускаемые примеры
FLUSH
FLUSH передаёт накопленные байты записи в файловый поток.
Синтаксис, аргументы и результат
FLUSH(<файл>)| Аргумент | Что передать |
|---|---|
<файл> | Значение аргумента должно быть значением открытого файла типа FILE. имеет тип FILE. Значение типа FILE обозначает ресурс, открытый оператором OPEN в режиме OUTPUT или APPEND. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание FLUSH: поведение, ограничения и примеры
Запускаемые примеры
FREESPACE
FREESPACE возвращает число свободных байтов диска, доступных текущему пользователю.
Синтаксис, аргументы и результат
FREESPACE(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь, по корню которого выбирается диск. |
Результат. Функция возвращает целое число типа LONG.
Описание FREESPACE: поведение, ограничения и примеры
Запускаемые примеры
FROMINSTANT
FROMINSTANT возвращает календарную дату-время, в которую заданный момент выглядит в выбранном поясе.
Синтаксис, аргументы и результат
FROMINSTANT(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть моментом времени типа UTCDATETIME. Передайте значение UTCDATETIME. |
Результат. Функция возвращает дату и время типа DATETIME.
FROMINSTANT(<значение>, <часовой пояс>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть моментом времени типа UTCDATETIME. Передайте значение UTCDATETIME. |
<часовой пояс> | Значение аргумента должно быть строкой типа STRING. Укажите UTC, LOCAL или системный идентификатор пояса, в котором нужно показать момент. |
Результат. Функция возвращает дату и время типа DATETIME.
Описание FROMINSTANT: поведение, ограничения и примеры
Запускаемые примеры
FROMUTC
FROMUTC возвращает дату и время, преобразованные из UTC в выбранный пояс.
Синтаксис, аргументы и результат
FROMUTC(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть датой и временем типа DATETIME. Передайте дату и время, записанные в UTC, которые требуется перевести в другой часовой пояс. |
Результат. Функция возвращает дату и время типа DATETIME.
FROMUTC(<значение>, <часовой пояс>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть датой и временем типа DATETIME. Передайте дату и время, записанные в UTC, которые требуется перевести в другой часовой пояс. |
<часовой пояс> | Значение аргумента должно быть строкой типа STRING. Укажите целевой пояс строкой UTC, LOCAL или системным идентификатором, известным среде запуска; без этого аргумента выбирается местный пояс. |
Результат. Функция возвращает дату и время типа DATETIME.
Описание FROMUTC: поведение, ограничения и примеры
Запускаемые примеры
FULLPATH
FULLPATH преобразует строку пути в полный путь.
Синтаксис, аргументы и результат
FULLPATH(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт строку пути, которую нужно разобрать или нормализовать. |
Результат. Функция возвращает строку типа STRING.
Описание FULLPATH: поведение, ограничения и примеры
Запускаемые примеры
GETDIRS
GETDIRS возвращает массив полных путей каталогов непосредственно в указанном каталоге.
Синтаксис, аргументы и результат
GETDIRS(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к каталогу. |
Результат. Функция возвращает одномерный массив строк типа STRING[].
GETDIRS(<путь>, <шаблон>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к каталогу. |
<шаблон> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка маски отбирает имена в указанном каталоге; например, *.txt. Пустая маска недопустима. |
Результат. Функция возвращает одномерный массив строк типа STRING[].
Описание GETDIRS: поведение, ограничения и примеры
Запускаемые примеры
GETFILES
GETFILES возвращает массив полных путей файлов непосредственно в указанном каталоге.
Синтаксис, аргументы и результат
GETFILES(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к каталогу. |
Результат. Функция возвращает одномерный массив строк типа STRING[].
GETFILES(<путь>, <шаблон>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к каталогу. |
<шаблон> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка маски отбирает имена в указанном каталоге; например, *.txt. Пустая маска недопустима. |
Результат. Функция возвращает одномерный массив строк типа STRING[].
Описание GETFILES: поведение, ограничения и примеры
Запускаемые примеры
HOUR
HOUR возвращает час времени суток.
Синтаксис, аргументы и результат
HOUR(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть временем суток типа TIME. Передайте время, из которого требуется извлечь номер часа. |
Результат. Функция возвращает целое число типа INTEGER.
Описание HOUR: поведение, ограничения и примеры
Запускаемые примеры
IMAGEHEIGHT
IMAGEHEIGHT возвращает высоту загруженного изображения в пикселях или 0 для пустого значения изображения.
Синтаксис, аргументы и результат
IMAGEHEIGHT(<изображение>)| Аргумент | Что передать |
|---|---|
<изображение> | Значение аргумента должно быть изображением типа IMAGE. Передайте изображение, высоту которого требуется измерить; открывать графическую поверхность для чтения размера не нужно. |
Результат. Функция возвращает целое число типа INTEGER.
Описание IMAGEHEIGHT: поведение, ограничения и примеры
Запускаемые примеры
IMAGEWIDTH
IMAGEWIDTH возвращает ширину загруженного изображения в пикселях или 0 для пустого значения изображения.
Синтаксис, аргументы и результат
IMAGEWIDTH(<изображение>)| Аргумент | Что передать |
|---|---|
<изображение> | Значение аргумента должно быть изображением типа IMAGE. Передайте изображение, ширину которого требуется измерить; результат относится к самому ресурсу, а не к его размеру после масштабирования при выводе. |
Результат. Функция возвращает целое число типа INTEGER.
Описание IMAGEWIDTH: поведение, ограничения и примеры
Запускаемые примеры
INKEY
INKEY извлекает следующую клавишу из очереди ввода без ожидания и возвращает её строковое представление либо пустую строку, если очередь пуста.
Синтаксис, аргументы и результат
INKEY()Функция вызывается без аргументов.
Результат. Функция возвращает строку типа STRING.
Описание INKEY: поведение, ограничения и примеры
Запускаемые примеры
INSERT
INSERT возвращает строку, вставив фрагмент перед указанной позицией.
Синтаксис, аргументы и результат
INSERT(<текст>, <начальная позиция>, <фрагмент>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<начальная позиция> | Значение аргумента должно быть целым числом типа INTEGER. Передайте целое число типа INTEGER с начальной позицией. Позиции отсчитываются от 1. |
<фрагмент> | Значение аргумента должно быть строкой типа STRING. Передайте строку типа STRING, которую требуется вставить. |
Результат. Функция возвращает строку типа STRING.
Описание INSERT: поведение, ограничения и примеры
Запускаемые примеры
INSTANTVALUE
INSTANTVALUE возвращает момент времени, прочитанный из текста с признаком UTC.
Синтаксис, аргументы и результат
INSTANTVALUE(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть строкой типа STRING. Передайте строку вида yyyy-MM-ddTHH:mm:ssZ. Допускается дробная часть секунд. Смещение вида +03:00 и запись без признака Z не принимаются. |
Результат. Функция возвращает момент времени типа UTCDATETIME.
Описание INSTANTVALUE: поведение, ограничения и примеры
Запускаемые примеры
INSTR
INSTR возвращает позицию первого вхождения фрагмента в строку.
Синтаксис, аргументы и результат
INSTR(<текст>, <фрагмент>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<фрагмент> | Значение аргумента должно быть строкой типа STRING. Передайте строку типа STRING, которую требуется найти в исходном тексте. |
Результат. Функция возвращает целое число типа INTEGER.
INSTR(<начальная позиция>, <текст>, <фрагмент>)| Аргумент | Что передать |
|---|---|
<начальная позиция> | Значение аргумента должно быть целым числом типа INTEGER. Передайте целое число типа INTEGER с начальной позицией. Позиции отсчитываются от 1. |
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<фрагмент> | Значение аргумента должно быть строкой типа STRING. Передайте строку типа STRING, которую требуется найти в исходном тексте. |
Результат. Функция возвращает целое число типа INTEGER.
Описание INSTR: поведение, ограничения и примеры
Запускаемые примеры
INSTRREV
INSTRREV возвращает позицию вхождения фрагмента, найденного при поиске справа налево.
Синтаксис, аргументы и результат
INSTRREV(<текст>, <фрагмент>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<фрагмент> | Значение аргумента должно быть строкой типа STRING. Передайте строку типа STRING, которую требуется найти в исходном тексте. |
Результат. Функция возвращает целое число типа INTEGER.
INSTRREV(<начальная позиция>, <текст>, <фрагмент>)| Аргумент | Что передать |
|---|---|
<начальная позиция> | Значение аргумента должно быть целым числом типа INTEGER. Передайте положительное целое число типа INTEGER с правой границей поиска в кодовых единицах UTF-16. Без аргумента используется длина строки; значение больше длины ограничивается её длиной. |
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<фрагмент> | Значение аргумента должно быть строкой типа STRING. Передайте строку типа STRING, которую требуется найти в исходном тексте. |
Результат. Функция возвращает целое число типа INTEGER.
Описание INSTRREV: поведение, ограничения и примеры
Запускаемые примеры
INT
INT возвращает наибольшее целое, не превышающее число.
Синтаксис, аргументы и результат
INT(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Допустимые числовые типы и результат описаны ниже. Передайте число, для которого требуется целочисленный результат округления вниз. |
Результат. Функция возвращает целое число типа INTEGER.
Описание INT: поведение, ограничения и примеры
Запускаемые примеры
ISABSOLUTEPATH
ISABSOLUTEPATH проверяет, полностью ли задан путь без обращения к рабочему каталогу.
Синтаксис, аргументы и результат
ISABSOLUTEPATH(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт строку пути, которую нужно разобрать или нормализовать. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание ISABSOLUTEPATH: поведение, ограничения и примеры
Запускаемые примеры
ISDATE
ISDATE возвращает признак допустимости канонической строки даты, времени или даты-времени.
Синтаксис, аргументы и результат
ISDATE(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть строкой типа STRING. Передайте строку, которую нужно проверить как запись даты, времени или даты и времени; проверяются и форма записи, и допустимость компонентов. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание ISDATE: поведение, ограничения и примеры
Запускаемые примеры
ISLEAPYEAR
ISLEAPYEAR возвращает признак високосности года.
Синтаксис, аргументы и результат
ISLEAPYEAR(<год>)| Аргумент | Что передать |
|---|---|
<год> | Значение аргумента должно быть целым числом типа INTEGER. Укажите календарный год от 1 до 9999, для которого нужно проверить наличие 29 февраля. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание ISLEAPYEAR: поведение, ограничения и примеры
Запускаемые примеры
ISNUMERIC
ISNUMERIC проверяет, можно ли прочитать строку целиком как число типа DOUBLE. Возвращает TRUE или FALSE.
Синтаксис, аргументы и результат
ISNUMERIC(<текст>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Строка, которую нужно проверить. Допустимы десятичная точка и экспоненциальная запись; пробельные символы по краям учитываются по правилам ISNUMERIC. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание ISNUMERIC: поведение, ограничения и примеры
Запускаемые примеры
ISOPEN
ISOPEN проверяет, открыт ли ресурс FILE.
Синтаксис, аргументы и результат
ISOPEN(<файл>)| Аргумент | Что передать |
|---|---|
<файл> | Значение аргумента должно быть значением открытого файла типа FILE. имеет тип FILE. Значение типа FILE обозначает проверяемый ресурс; неоткрытое и закрытое значения также разрешены. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание ISOPEN: поведение, ограничения и примеры
Запускаемые примеры
ISREADONLY
ISREADONLY проверяет атрибут «только для чтения» файла или каталога.
Синтаксис, аргументы и результат
ISREADONLY(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к файлу или каталогу. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание ISREADONLY: поведение, ограничения и примеры
Запускаемые примеры
JOIN
JOIN соединяет элементы массива строк и возвращает одну строку.
Синтаксис, аргументы и результат
JOIN(<элементы>)| Аргумент | Что передать |
|---|---|
<элементы> | Допустимый тип значения: STRING[]. Передайте одномерный массив строк STRING[], элементы которого нужно соединить. |
Результат. Функция возвращает строку типа STRING.
JOIN(<элементы>, <разделитель>)| Аргумент | Что передать |
|---|---|
<элементы> | Допустимый тип значения: STRING[]. Передайте одномерный массив строк STRING[], элементы которого нужно соединить. |
<разделитель> | Значение аргумента должно быть строкой типа STRING. Передайте строку типа STRING, вставляемую между соседними элементами. Она может быть пустой; без аргумента используется запятая. |
Результат. Функция возвращает строку типа STRING.
Описание JOIN: поведение, ограничения и примеры
Запускаемые примеры
KEYDOWN
KEYDOWN проверяет текущее удержание клавиши или всех клавиш сочетания, сохраняя события в очереди ввода.
Синтаксис, аргументы и результат
KEYDOWN(<клавиша>)| Аргумент | Что передать |
|---|---|
<клавиша> | Значение аргумента должно быть строкой типа STRING. Укажите строковое имя клавиши либо сочетание имён через знак +; для сочетания все перечисленные клавиши должны удерживаться одновременно. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание KEYDOWN: поведение, ограничения и примеры
Запускаемые примеры
KEYPRESS
KEYPRESS ищет непрочитанное нажатие клавиши, удаляет первое подходящее событие из очереди и сообщает, было ли оно найдено.
Синтаксис, аргументы и результат
KEYPRESS(<клавиша>)| Аргумент | Что передать |
|---|---|
<клавиша> | Значение аргумента должно быть строкой типа STRING. Укажите имя клавиши либо сочетание через знак +; в сочетании последняя клавиша должна прийти событием нажатия, а предыдущие должны удерживаться. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание KEYPRESS: поведение, ограничения и примеры
Запускаемые примеры
LBOUND
LBOUND возвращает нижнюю границу выбранного измерения массива.
Синтаксис, аргументы и результат
LBOUND(<массив>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
Результат. Функция возвращает целое число типа INTEGER.
LBOUND(<массив>, <измерение>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<измерение> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER выбирает измерение от 1 до ранга включительно. ROW равно 1, COLUMN равно 2. Без этого аргумента выбирается первое измерение, в том числе у многомерного массива. |
Результат. Функция возвращает целое число типа INTEGER.
Описание LBOUND: поведение, ограничения и примеры
Запускаемые примеры
LCASE
LCASE возвращает строку, преобразовав буквы в нижний регистр.
Синтаксис, аргументы и результат
LCASE(<текст>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
Результат. Функция возвращает строку типа STRING.
Описание LCASE: поведение, ограничения и примеры
Запускаемые примеры
LEFT
LEFT возвращает фрагмент заданной длины из начала строки.
Синтаксис, аргументы и результат
LEFT(<текст>, <количество>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<количество> | Значение аргумента должно быть целым числом типа INTEGER. Передайте целое число типа INTEGER, задающее количество единиц текста. Значение должно быть больше нуля. |
Результат. Функция возвращает строку типа STRING.
LEFT(<текст>, <количество>, <единица измерения>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<количество> | Значение аргумента должно быть целым числом типа INTEGER. Передайте целое число типа INTEGER, задающее количество единиц текста. Значение должно быть больше нуля. |
<единица измерения> | Значение аргумента должно быть строкой типа STRING. Передайте строку типа STRING: "UTF16", "CODEPOINT" или "GRAPHEME". Регистр букв несущественен, пробелы не удаляются. Без этого аргумента используется UTF16. |
Результат. Функция возвращает строку типа STRING.
Описание LEFT: поведение, ограничения и примеры
Запускаемые примеры
LEN
LEN возвращает длину строки в выбранных единицах текста.
Синтаксис, аргументы и результат
LEN(<текст>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
Результат. Функция возвращает целое число типа INTEGER.
LEN(<текст>, <единица измерения>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<единица измерения> | Значение аргумента должно быть строкой типа STRING. Передайте строку типа STRING: "UTF16", "CODEPOINT" или "GRAPHEME". Регистр букв несущественен, пробелы не удаляются. Без этого аргумента используется UTF16. |
Результат. Функция возвращает целое число типа INTEGER.
Описание LEN: поведение, ограничения и примеры
Запускаемые примеры
LINENUMBER
LINENUMBER возвращает номер строки в текущей позиции чтения.
Синтаксис, аргументы и результат
LINENUMBER(<файл>)| Аргумент | Что передать |
|---|---|
<файл> | Значение аргумента должно быть значением открытого файла типа FILE. имеет тип FILE. Значение типа FILE обозначает ресурс, открытый оператором OPEN в режиме INPUT. |
Результат. Функция возвращает целое число типа LONG.
Описание LINENUMBER: поведение, ограничения и примеры
Запускаемые примеры
LOADIMAGE
LOADIMAGE загружает файл изображения и возвращает ресурс, который можно измерять и рисовать на графической поверхности.
Синтаксис, аргументы и результат
LOADIMAGE(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. Укажите путь к файлу изображения; в сохранённой программе относительный путь считается от каталога её файла .axm. |
Результат. Функция возвращает изображение типа IMAGE.
Описание LOADIMAGE: поведение, ограничения и примеры
Запускаемые примеры
LOADSPRITE
LOADSPRITE загружает изображение как спрайтовый лист и разбивает его на прямоугольные кадры указанного размера.
Синтаксис, аргументы и результат
LOADSPRITE(<путь>, <ширина кадра>, <высота кадра>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. Укажите путь к изображению, содержащему кадры спрайтового листа. |
<ширина кадра> | Значение аргумента должно быть целым числом типа LONG. Укажите положительную ширину одного кадра в пикселях, чтобы определить горизонтальное разбиение листа. |
<высота кадра> | Значение аргумента должно быть целым числом типа LONG. Укажите положительную высоту одного кадра в пикселях, чтобы определить вертикальное разбиение листа. |
Результат. Функция возвращает спрайт типа SPRITE.
Описание LOADSPRITE: поведение, ограничения и примеры
Запускаемые примеры
LOADTILEMAP
LOADTILEMAP принимает путь типа STRING, читает карту Tiled и возвращает значение типа TILEMAP.
Синтаксис, аргументы и результат
LOADTILEMAP(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. Укажите путь к файлу карты .tmj или .json; в IDE относительный путь отсчитывается от каталога запускаемой программы. |
Результат. Функция возвращает тайловую карту типа TILEMAP.
Описание LOADTILEMAP: поведение, ограничения и примеры
Запускаемые примеры
LOADTILESET
LOADTILESET загружает изображение с сеткой тайлов и возвращает TILESET.
Синтаксис, аргументы и результат
LOADTILESET(<путь>, <ширина тайла>, <высота тайла>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. Укажите путь к изображению-атласу, в котором расположены тайлы одинакового размера. |
<ширина тайла> | Значение аргумента должно быть целым числом типа LONG. Укажите положительную ширину одного тайла в пикселях, чтобы определить число столбцов сетки. |
<высота тайла> | Значение аргумента должно быть целым числом типа LONG. Укажите положительную высоту одного тайла в пикселях, чтобы определить число строк сетки. |
Результат. Функция возвращает набор тайлов типа TILESET.
LOADTILESET(<путь>, <ширина тайла>, <высота тайла>, <отступ>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. Укажите путь к изображению-атласу, в котором расположены тайлы одинакового размера. |
<ширина тайла> | Значение аргумента должно быть целым числом типа LONG. Укажите положительную ширину одного тайла в пикселях, чтобы определить число столбцов сетки. |
<высота тайла> | Значение аргумента должно быть целым числом типа LONG. Укажите положительную высоту одного тайла в пикселях, чтобы определить число строк сетки. |
<отступ> | Значение аргумента должно быть целым числом типа LONG. Укажите неотрицательный отступ сетки от каждого края атласа в пикселях; без этого аргумента отступ равен 0. |
Результат. Функция возвращает набор тайлов типа TILESET.
LOADTILESET(<путь>, <ширина тайла>, <высота тайла>, <отступ>, <промежуток>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. Укажите путь к изображению-атласу, в котором расположены тайлы одинакового размера. |
<ширина тайла> | Значение аргумента должно быть целым числом типа LONG. Укажите положительную ширину одного тайла в пикселях, чтобы определить число столбцов сетки. |
<высота тайла> | Значение аргумента должно быть целым числом типа LONG. Укажите положительную высоту одного тайла в пикселях, чтобы определить число строк сетки. |
<отступ> | Значение аргумента должно быть целым числом типа LONG. Укажите неотрицательный отступ сетки от каждого края атласа в пикселях; без этого аргумента отступ равен 0. |
<промежуток> | Значение аргумента должно быть целым числом типа LONG. Укажите неотрицательный промежуток между соседними тайлами в пикселях; без этого аргумента промежуток равен 0. |
Результат. Функция возвращает набор тайлов типа TILESET.
Описание LOADTILESET: поведение, ограничения и примеры
Запускаемые примеры
LOG
LOG возвращает натуральный логарифм числа.
Синтаксис, аргументы и результат
LOG(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Перед вычислением оно преобразуется в DOUBLE. Передайте положительное число, натуральный логарифм которого требуется вычислить. |
Результат. Функция возвращает число типа DOUBLE.
Описание LOG: поведение, ограничения и примеры
Запускаемые примеры
LOG10
LOG10 возвращает десятичный логарифм числа.
Синтаксис, аргументы и результат
LOG10(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Перед вычислением оно преобразуется в DOUBLE. Передайте положительное число, десятичный логарифм которого требуется вычислить. |
Результат. Функция возвращает число типа DOUBLE.
Описание LOG10: поведение, ограничения и примеры
Запускаемые примеры
LOG2
LOG2 возвращает двоичный логарифм числа.
Синтаксис, аргументы и результат
LOG2(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Перед вычислением оно преобразуется в DOUBLE. Передайте положительное число, двоичный логарифм которого требуется вычислить. |
Результат. Функция возвращает число типа DOUBLE.
Описание LOG2: поведение, ограничения и примеры
Запускаемые примеры
LTRIM
LTRIM возвращает строку после удаления заданных символов с начала текста.
Синтаксис, аргументы и результат
LTRIM(<текст>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
Результат. Функция возвращает строку типа STRING.
LTRIM(<текст>, <символы>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<символы> | Значение аргумента должно быть строкой типа STRING. Передайте строку типа STRING, перечисляющую удаляемые кодовые единицы UTF-16. Это набор отдельных символов, а не подстрока. Если аргумент отсутствует, удаляются пробельные символы, распознаваемые .NET. |
Результат. Функция возвращает строку типа STRING.
Описание LTRIM: поведение, ограничения и примеры
Запускаемые примеры
MAKEDIR
MAKEDIR создаёт каталог и недостающие родительские каталоги.
Синтаксис, аргументы и результат
MAKEDIR(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к каталогу. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание MAKEDIR: поведение, ограничения и примеры
Запускаемые примеры
MAKETEMPDIR
MAKETEMPDIR создаёт каталог со случайным именем во временной папке системы.
Синтаксис, аргументы и результат
MAKETEMPDIR(<префикс>)| Аргумент | Что передать |
|---|---|
<префикс> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка префикса добавляется к случайному имени временного объекта; путь и недопустимые символы имени запрещены. Пустой префикс разрешён. |
Результат. Функция возвращает строку типа STRING.
Описание MAKETEMPDIR: поведение, ограничения и примеры
Запускаемые примеры
MAKETEMPFILE
MAKETEMPFILE создаёт пустой файл со случайным именем во временной папке системы.
Синтаксис, аргументы и результат
MAKETEMPFILE(<префикс>)| Аргумент | Что передать |
|---|---|
<префикс> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка префикса добавляется к случайному имени временного объекта; путь и недопустимые символы имени запрещены. Пустой префикс разрешён. |
Результат. Функция возвращает строку типа STRING.
Описание MAKETEMPFILE: поведение, ограничения и примеры
Запускаемые примеры
MAPCOLUMN
MAPCOLUMN переводит мировую координату X в номер столбца карты.
Синтаксис, аргументы и результат
MAPCOLUMN(<тайловая карта>, <начальная x>, <мировая x>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, ширина клетки и число столбцов которой определяют перевод координаты. |
<начальная x> | Значение аргумента должно быть числом типа DOUBLE. Укажите мировую координату левого края карты в пикселях, от которой отсчитывается положение точки. |
<мировая x> | Значение аргумента должно быть числом типа DOUBLE. Укажите мировую координату X точки в пикселях, для которой нужно получить номер столбца. |
Результат. Функция возвращает целое число типа INTEGER.
Описание MAPCOLUMN: поведение, ограничения и примеры
Запускаемые примеры
MAPHEIGHT
MAPHEIGHT возвращает высоту карты в клетках.
Синтаксис, аргументы и результат
MAPHEIGHT(<тайловая карта>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, число строк которой требуется узнать. |
Результат. Функция возвращает целое число типа INTEGER.
Описание MAPHEIGHT: поведение, ограничения и примеры
Запускаемые примеры
MAPLAYERCOUNT
MAPLAYERCOUNT возвращает число слоёв карты.
Синтаксис, аргументы и результат
MAPLAYERCOUNT(<тайловая карта>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, общее число слоёв которой требуется определить. |
Результат. Функция возвращает целое число типа INTEGER.
Описание MAPLAYERCOUNT: поведение, ограничения и примеры
Запускаемые примеры
MAPLAYERNAME
MAPLAYERNAME возвращает имя слоя.
Синтаксис, аргументы и результат
MAPLAYERNAME(<тайловая карта>, <индекс слоя>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, содержащую слой, имя которого требуется прочитать. |
<индекс слоя> | Значение аргумента должно быть целым числом типа LONG. Укажите номер слоя начиная с 1; порядок номеров соответствует порядку слоёв в файле карты. |
Результат. Функция возвращает строку типа STRING.
Описание MAPLAYERNAME: поведение, ограничения и примеры
Запускаемые примеры
MAPLAYERPROPERTY
MAPLAYERPROPERTY возвращает пользовательское свойство слоя.
Синтаксис, аргументы и результат
MAPLAYERPROPERTY(<тайловая карта>, <индекс слоя>, <имя>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, в слое которой хранится нужное пользовательское свойство. |
<индекс слоя> | Значение аргумента должно быть целым числом типа LONG. Укажите номер слоя начиная с 1, чтобы выбрать слой с нужным свойством. |
<имя> | Значение аргумента должно быть строкой типа STRING. Передайте имя пользовательского свойства слоя; регистр букв в имени учитывается. |
Результат. Функция возвращает строку типа STRING.
Описание MAPLAYERPROPERTY: поведение, ограничения и примеры
Запускаемые примеры
MAPLAYERTYPE
MAPLAYERTYPE возвращает вид слоя: TILE или OBJECT.
Синтаксис, аргументы и результат
MAPLAYERTYPE(<тайловая карта>, <индекс слоя>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, вид слоя которой требуется определить. |
<индекс слоя> | Значение аргумента должно быть целым числом типа LONG. Укажите номер проверяемого слоя начиная с 1. |
Результат. Функция возвращает строку типа STRING.
Описание MAPLAYERTYPE: поведение, ограничения и примеры
Запускаемые примеры
MAPLAYERVISIBLE
MAPLAYERVISIBLE возвращает флаг видимости слоя.
Синтаксис, аргументы и результат
MAPLAYERVISIBLE(<тайловая карта>, <индекс слоя>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, из которой требуется прочитать настройку видимости слоя. |
<индекс слоя> | Значение аргумента должно быть целым числом типа LONG. Укажите номер слоя начиная с 1, флаг видимости которого нужно проверить. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание MAPLAYERVISIBLE: поведение, ограничения и примеры
Запускаемые примеры
MAPOBJECTCLASS
MAPOBJECTCLASS возвращает класс объекта из class или type.
Синтаксис, аргументы и результат
MAPOBJECTCLASS(<тайловая карта>, <индекс слоя>, <индекс объекта>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, содержащую объект, класс которого требуется узнать. |
<индекс слоя> | Значение аргумента должно быть целым числом типа LONG. Укажите номер объектного слоя начиная с 1, чтобы выбрать список объектов. |
<индекс объекта> | Значение аргумента должно быть целым числом типа LONG. Укажите номер объекта внутри выбранного слоя начиная с 1. |
Результат. Функция возвращает строку типа STRING.
Описание MAPOBJECTCLASS: поведение, ограничения и примеры
Запускаемые примеры
MAPOBJECTCOUNT
MAPOBJECTCOUNT возвращает число объектов слоя.
Синтаксис, аргументы и результат
MAPOBJECTCOUNT(<тайловая карта>, <индекс слоя>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, объекты слоя которой требуется подсчитать. |
<индекс слоя> | Значение аргумента должно быть целым числом типа LONG. Укажите номер слоя начиная с 1, для которого нужно получить число объектов. |
Результат. Функция возвращает целое число типа INTEGER.
Описание MAPOBJECTCOUNT: поведение, ограничения и примеры
Запускаемые примеры
MAPOBJECTHEIGHT
MAPOBJECTHEIGHT возвращает высоту объекта.
Синтаксис, аргументы и результат
MAPOBJECTHEIGHT(<тайловая карта>, <индекс слоя>, <индекс объекта>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, содержащую объект, высоту которого требуется измерить. |
<индекс слоя> | Значение аргумента должно быть целым числом типа LONG. Укажите номер объектного слоя начиная с 1. |
<индекс объекта> | Значение аргумента должно быть целым числом типа LONG. Укажите номер объекта внутри этого слоя начиная с 1; размер читается без учёта камеры. |
Результат. Функция возвращает число типа DOUBLE.
Описание MAPOBJECTHEIGHT: поведение, ограничения и примеры
Запускаемые примеры
MAPOBJECTKIND
MAPOBJECTKIND возвращает вид объекта: POINT или RECT.
Синтаксис, аргументы и результат
MAPOBJECTKIND(<тайловая карта>, <индекс слоя>, <индекс объекта>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, в которой нужно определить геометрический вид объекта. |
<индекс слоя> | Значение аргумента должно быть целым числом типа LONG. Укажите номер объектного слоя начиная с 1. |
<индекс объекта> | Значение аргумента должно быть целым числом типа LONG. Укажите номер объекта внутри выбранного слоя начиная с 1. |
Результат. Функция возвращает строку типа STRING.
Описание MAPOBJECTKIND: поведение, ограничения и примеры
Запускаемые примеры
MAPOBJECTNAME
MAPOBJECTNAME возвращает имя объекта.
Синтаксис, аргументы и результат
MAPOBJECTNAME(<тайловая карта>, <индекс слоя>, <индекс объекта>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, содержащую объект, имя которого требуется прочитать. |
<индекс слоя> | Значение аргумента должно быть целым числом типа LONG. Укажите номер объектного слоя начиная с 1. |
<индекс объекта> | Значение аргумента должно быть целым числом типа LONG. Укажите номер объекта внутри выбранного слоя начиная с 1. |
Результат. Функция возвращает строку типа STRING.
Описание MAPOBJECTNAME: поведение, ограничения и примеры
Запускаемые примеры
MAPOBJECTPROPERTY
MAPOBJECTPROPERTY возвращает пользовательское свойство объекта.
Синтаксис, аргументы и результат
MAPOBJECTPROPERTY(<тайловая карта>, <индекс слоя>, <индекс объекта>, <имя>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, в объекте которой хранится нужное пользовательское свойство. |
<индекс слоя> | Значение аргумента должно быть целым числом типа LONG. Укажите номер объектного слоя начиная с 1. |
<индекс объекта> | Значение аргумента должно быть целым числом типа LONG. Укажите номер объекта внутри выбранного слоя начиная с 1. |
<имя> | Значение аргумента должно быть строкой типа STRING. Передайте имя свойства объекта; поиск учитывает регистр букв. |
Результат. Функция возвращает строку типа STRING.
Описание MAPOBJECTPROPERTY: поведение, ограничения и примеры
Запускаемые примеры
MAPOBJECTVISIBLE
MAPOBJECTVISIBLE возвращает флаг видимости объекта.
Синтаксис, аргументы и результат
MAPOBJECTVISIBLE(<тайловая карта>, <индекс слоя>, <индекс объекта>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, из которой требуется прочитать настройку видимости объекта. |
<индекс слоя> | Значение аргумента должно быть целым числом типа LONG. Укажите номер объектного слоя начиная с 1. |
<индекс объекта> | Значение аргумента должно быть целым числом типа LONG. Укажите номер объекта внутри выбранного слоя начиная с 1, чтобы проверить его флаг видимости. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание MAPOBJECTVISIBLE: поведение, ограничения и примеры
Запускаемые примеры
MAPOBJECTWIDTH
MAPOBJECTWIDTH возвращает ширину объекта.
Синтаксис, аргументы и результат
MAPOBJECTWIDTH(<тайловая карта>, <индекс слоя>, <индекс объекта>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, содержащую объект, ширину которого требуется измерить. |
<индекс слоя> | Значение аргумента должно быть целым числом типа LONG. Укажите номер объектного слоя начиная с 1. |
<индекс объекта> | Значение аргумента должно быть целым числом типа LONG. Укажите номер объекта внутри этого слоя начиная с 1; размер не зависит от смещения камеры. |
Результат. Функция возвращает число типа DOUBLE.
Описание MAPOBJECTWIDTH: поведение, ограничения и примеры
Запускаемые примеры
MAPOBJECTX
MAPOBJECTX возвращает координату X объекта.
Синтаксис, аргументы и результат
MAPOBJECTX(<тайловая карта>, <индекс слоя>, <индекс объекта>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, содержащую объект, горизонтальное положение которого требуется прочитать. |
<индекс слоя> | Значение аргумента должно быть целым числом типа LONG. Укажите номер объектного слоя начиная с 1. |
<индекс объекта> | Значение аргумента должно быть целым числом типа LONG. Укажите номер объекта внутри выбранного слоя начиная с 1. |
Результат. Функция возвращает число типа DOUBLE.
Описание MAPOBJECTX: поведение, ограничения и примеры
Запускаемые примеры
MAPOBJECTY
MAPOBJECTY возвращает координату Y объекта.
Синтаксис, аргументы и результат
MAPOBJECTY(<тайловая карта>, <индекс слоя>, <индекс объекта>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, содержащую объект, вертикальное положение которого требуется прочитать. |
<индекс слоя> | Значение аргумента должно быть целым числом типа LONG. Укажите номер объектного слоя начиная с 1. |
<индекс объекта> | Значение аргумента должно быть целым числом типа LONG. Укажите номер объекта внутри выбранного слоя начиная с 1. |
Результат. Функция возвращает число типа DOUBLE.
Описание MAPOBJECTY: поведение, ограничения и примеры
Запускаемые примеры
MAPPIXELHEIGHT
MAPPIXELHEIGHT возвращает высоту карты в пикселях.
Синтаксис, аргументы и результат
MAPPIXELHEIGHT(<тайловая карта>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, высоту сетки которой требуется получить в пикселях. |
Результат. Функция возвращает целое число типа INTEGER.
Описание MAPPIXELHEIGHT: поведение, ограничения и примеры
Запускаемые примеры
MAPPIXELWIDTH
MAPPIXELWIDTH возвращает ширину карты в пикселях.
Синтаксис, аргументы и результат
MAPPIXELWIDTH(<тайловая карта>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, ширину сетки которой требуется получить в пикселях. |
Результат. Функция возвращает целое число типа INTEGER.
Описание MAPPIXELWIDTH: поведение, ограничения и примеры
Запускаемые примеры
MAPPROPERTY
MAPPROPERTY возвращает пользовательское свойство карты.
Синтаксис, аргументы и результат
MAPPROPERTY(<тайловая карта>, <имя>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, пользовательское свойство которой требуется прочитать. |
<имя> | Значение аргумента должно быть строкой типа STRING. Укажите имя свойства карты; регистр букв учитывается при поиске. |
Результат. Функция возвращает строку типа STRING.
Описание MAPPROPERTY: поведение, ограничения и примеры
Запускаемые примеры
MAPROW
MAPROW переводит мировую координату Y в номер строки карты.
Синтаксис, аргументы и результат
MAPROW(<тайловая карта>, <начальная y>, <мировая y>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, высота клетки и число строк которой определяют перевод координаты. |
<начальная y> | Значение аргумента должно быть числом типа DOUBLE. Укажите мировую координату верхнего края карты в пикселях, от которой отсчитывается положение точки. |
<мировая y> | Значение аргумента должно быть числом типа DOUBLE. Укажите мировую координату Y точки в пикселях, для которой нужно получить номер строки. |
Результат. Функция возвращает целое число типа INTEGER.
Описание MAPROW: поведение, ограничения и примеры
Запускаемые примеры
MAPTILE
MAPTILE возвращает номер тайла внутри тайлсета.
Синтаксис, аргументы и результат
MAPTILE(<тайловая карта>, <индекс слоя>, <столбец>, <строка>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, клетку которой требуется прочитать. |
<индекс слоя> | Значение аргумента должно быть целым числом типа LONG. Укажите номер тайлового слоя начиная с 1, в котором расположена клетка. |
<столбец> | Значение аргумента должно быть целым числом типа LONG. Укажите номер столбца клетки начиная с 1. |
<строка> | Значение аргумента должно быть целым числом типа LONG. Укажите номер строки клетки начиная с 1. |
Результат. Функция возвращает целое число типа INTEGER.
Описание MAPTILE: поведение, ограничения и примеры
Запускаемые примеры
MAPTILEFLAGS
MAPTILEFLAGS возвращает битовую маску отражений тайла в клетке.
Синтаксис, аргументы и результат
MAPTILEFLAGS(<тайловая карта>, <индекс слоя>, <столбец>, <строка>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, преобразования тайла в клетке которой требуется узнать. |
<индекс слоя> | Значение аргумента должно быть целым числом типа LONG. Укажите номер тайлового слоя начиная с 1. |
<столбец> | Значение аргумента должно быть целым числом типа LONG. Укажите номер столбца клетки начиная с 1, чтобы выбрать тайл для чтения его флагов. |
<строка> | Значение аргумента должно быть целым числом типа LONG. Укажите номер строки той же клетки начиная с 1. |
Результат. Функция возвращает целое число типа INTEGER.
Описание MAPTILEFLAGS: поведение, ограничения и примеры
Запускаемые примеры
MAPTILEHEIGHT
MAPTILEHEIGHT возвращает высоту одной клетки в пикселях.
Синтаксис, аргументы и результат
MAPTILEHEIGHT(<тайловая карта>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, размер клетки которой по вертикали требуется узнать. |
Результат. Функция возвращает целое число типа INTEGER.
Описание MAPTILEHEIGHT: поведение, ограничения и примеры
Запускаемые примеры
MAPTILEPROPERTY
MAPTILEPROPERTY возвращает свойство фактического тайла в клетке.
Синтаксис, аргументы и результат
MAPTILEPROPERTY(<тайловая карта>, <индекс слоя>, <столбец>, <строка>, <имя>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, в клетке которой расположен тайл с нужным свойством. |
<индекс слоя> | Значение аргумента должно быть целым числом типа LONG. Укажите номер тайлового слоя начиная с 1. |
<столбец> | Значение аргумента должно быть целым числом типа LONG. Укажите номер столбца клетки начиная с 1. |
<строка> | Значение аргумента должно быть целым числом типа LONG. Укажите номер строки клетки начиная с 1. |
<имя> | Значение аргумента должно быть строкой типа STRING. Передайте имя свойства тайла; поиск различает регистр и читает свойство текущего тайла этой клетки. |
Результат. Функция возвращает строку типа STRING.
Описание MAPTILEPROPERTY: поведение, ограничения и примеры
Запускаемые примеры
MAPTILESET
MAPTILESET возвращает номер тайлсета карты, к которому относится клетка.
Синтаксис, аргументы и результат
MAPTILESET(<тайловая карта>, <индекс слоя>, <столбец>, <строка>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, тайлсет клетки которой требуется определить. |
<индекс слоя> | Значение аргумента должно быть целым числом типа LONG. Укажите номер тайлового слоя начиная с 1. |
<столбец> | Значение аргумента должно быть целым числом типа LONG. Укажите номер столбца клетки начиная с 1. |
<строка> | Значение аргумента должно быть целым числом типа LONG. Укажите номер строки клетки начиная с 1. |
Результат. Функция возвращает целое число типа INTEGER.
Описание MAPTILESET: поведение, ограничения и примеры
Запускаемые примеры
MAPTILESETCOUNT
MAPTILESETCOUNT возвращает число тайлсетов карты.
Синтаксис, аргументы и результат
MAPTILESETCOUNT(<тайловая карта>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, число связанных тайлсетов которой требуется узнать. |
Результат. Функция возвращает целое число типа INTEGER.
Описание MAPTILESETCOUNT: поведение, ограничения и примеры
Запускаемые примеры
MAPTILEWIDTH
MAPTILEWIDTH возвращает ширину одной клетки в пикселях.
Синтаксис, аргументы и результат
MAPTILEWIDTH(<тайловая карта>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, размер клетки которой по горизонтали требуется узнать. |
Результат. Функция возвращает целое число типа INTEGER.
Описание MAPTILEWIDTH: поведение, ограничения и примеры
Запускаемые примеры
MAPWIDTH
MAPWIDTH возвращает ширину карты в клетках.
Синтаксис, аргументы и результат
MAPWIDTH(<тайловая карта>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, число столбцов которой требуется узнать. |
Результат. Функция возвращает целое число типа INTEGER.
Описание MAPWIDTH: поведение, ограничения и примеры
Запускаемые примеры
MAPWORLDX
MAPWORLDX возвращает мировую координату левой границы столбца.
Синтаксис, аргументы и результат
MAPWORLDX(<тайловая карта>, <начальная x>, <столбец>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, ширина клетки которой используется для вычисления мировой координаты столбца. |
<начальная x> | Значение аргумента должно быть числом типа DOUBLE. Укажите мировую координату левого края карты в пикселях. |
<столбец> | Значение аргумента должно быть целым числом типа LONG. Укажите номер столбца начиная с 1, левую границу которого требуется получить в мировых координатах. |
Результат. Функция возвращает число типа DOUBLE.
Описание MAPWORLDX: поведение, ограничения и примеры
Запускаемые примеры
MAPWORLDY
MAPWORLDY возвращает мировую координату верхней границы строки.
Синтаксис, аргументы и результат
MAPWORLDY(<тайловая карта>, <начальная y>, <строка>)| Аргумент | Что передать |
|---|---|
<тайловая карта> | Значение аргумента должно быть тайловой картой типа TILEMAP. Передайте карту, высота клетки которой используется для вычисления мировой координаты строки. |
<начальная y> | Значение аргумента должно быть числом типа DOUBLE. Укажите мировую координату верхнего края карты в пикселях. |
<строка> | Значение аргумента должно быть целым числом типа LONG. Укажите номер строки начиная с 1, верхнюю границу которой требуется получить в мировых координатах. |
Результат. Функция возвращает число типа DOUBLE.
Описание MAPWORLDY: поведение, ограничения и примеры
Запускаемые примеры
MAX
MAX возвращает большее из двух чисел.
Синтаксис, аргументы и результат
MAX(<левый операнд>, <правый операнд>)| Аргумент | Что передать |
|---|---|
<левый операнд> | Передаётся числовое выражение. Допустимые числовые типы и результат описаны ниже. Передайте первое число для сравнения. |
<правый операнд> | Передаётся числовое выражение. Допустимые числовые типы и результат описаны ниже. Передайте второе число, с которым нужно сравнить первое и выбрать большее значение. |
Результат. Функция возвращает значение общего числового типа своих аргументов.
Описание MAX: поведение, ограничения и примеры
Запускаемые примеры
MID
MID возвращает фрагмент строки, начиная с указанной позиции.
Синтаксис, аргументы и результат
MID(<текст>, <начальная позиция>, <количество>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<начальная позиция> | Значение аргумента должно быть целым числом типа INTEGER. Передайте целое число типа INTEGER с начальной позицией. Позиции отсчитываются от 1. |
<количество> | Значение аргумента должно быть целым числом типа INTEGER. Передайте целое число типа INTEGER, задающее количество единиц текста. Значение должно быть больше нуля. |
Результат. Функция возвращает строку типа STRING.
MID(<текст>, <начальная позиция>, <количество>, <единица измерения>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<начальная позиция> | Значение аргумента должно быть целым числом типа INTEGER. Передайте целое число типа INTEGER с начальной позицией. Позиции отсчитываются от 1. |
<количество> | Значение аргумента должно быть целым числом типа INTEGER. Передайте целое число типа INTEGER, задающее количество единиц текста. Значение должно быть больше нуля. |
<единица измерения> | Значение аргумента должно быть строкой типа STRING. Передайте строку типа STRING: "UTF16", "CODEPOINT" или "GRAPHEME". Регистр букв несущественен, пробелы не удаляются. Без этого аргумента используется UTF16. |
Результат. Функция возвращает строку типа STRING.
Описание MID: поведение, ограничения и примеры
Запускаемые примеры
MIN
MIN возвращает меньшее из двух чисел.
Синтаксис, аргументы и результат
MIN(<левый операнд>, <правый операнд>)| Аргумент | Что передать |
|---|---|
<левый операнд> | Передаётся числовое выражение. Допустимые числовые типы и результат описаны ниже. Передайте первое число для сравнения. |
<правый операнд> | Передаётся числовое выражение. Допустимые числовые типы и результат описаны ниже. Передайте второе число, с которым нужно сравнить первое и выбрать меньшее значение. |
Результат. Функция возвращает значение общего числового типа своих аргументов.
Описание MIN: поведение, ограничения и примеры
Запускаемые примеры
MINUTE
MINUTE возвращает минуту внутри часа.
Синтаксис, аргументы и результат
MINUTE(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть временем суток типа TIME. Передайте время, из которого требуется извлечь число минут внутри текущего часа. |
Результат. Функция возвращает целое число типа INTEGER.
Описание MINUTE: поведение, ограничения и примеры
Запускаемые примеры
MONTH
MONTH возвращает номер месяца календарной даты.
Синтаксис, аргументы и результат
MONTH(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть датой типа DATE. Передайте дату, из которой требуется извлечь номер месяца. |
Результат. Функция возвращает целое число типа INTEGER.
Описание MONTH: поведение, ограничения и примеры
Запускаемые примеры
MONTHNAME
MONTHNAME возвращает английское название месяца.
Синтаксис, аргументы и результат
MONTHNAME(<месяц>)| Аргумент | Что передать |
|---|---|
<месяц> | Значение аргумента должно быть целым числом типа INTEGER. Укажите номер месяца от 1 до 12, название которого требуется получить. |
Результат. Функция возвращает строку типа STRING.
Описание MONTHNAME: поведение, ограничения и примеры
Запускаемые примеры
MOUSEBUTTON
MOUSEBUTTON проверяет текущее удержание указанной кнопки мыши на активном графическом экране или холсте, не расходуя события очереди.
Синтаксис, аргументы и результат
MOUSEBUTTON(<номер кнопки>)| Аргумент | Что передать |
|---|---|
<номер кнопки> | Значение аргумента должно быть целым числом типа INTEGER. Укажите номер проверяемой кнопки: 1 для левой, 2 для правой или 3 для средней. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание MOUSEBUTTON: поведение, ограничения и примеры
Запускаемые примеры
MOUSEPRESS
MOUSEPRESS ищет непрочитанное нажатие указанной кнопки мыши, удаляет первое подходящее событие и сообщает, было ли оно найдено.
Синтаксис, аргументы и результат
MOUSEPRESS(<номер кнопки>)| Аргумент | Что передать |
|---|---|
<номер кнопки> | Значение аргумента должно быть целым числом типа INTEGER. Укажите номер кнопки, нажатие которой требуется прочитать: 1 для левой, 2 для правой или 3 для средней. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание MOUSEPRESS: поведение, ограничения и примеры
Запускаемые примеры
MOUSEX
MOUSEX возвращает LONG с горизонтальной координатой указателя: в SCREEN — физические пиксели клиентской области, на CANVAS — мировая координата с учётом VIEWPORT и CAMERA. Требует графическую поверхность.
Синтаксис, аргументы и результат
MOUSEX()Функция вызывается без аргументов.
Результат. Функция возвращает целое число типа LONG.
Описание MOUSEX: поведение, ограничения и примеры
Запускаемые примеры
MOUSEY
MOUSEY возвращает LONG с вертикальной координатой указателя: в SCREEN — физические пиксели клиентской области, на CANVAS — мировая координата с учётом VIEWPORT и CAMERA. Требует графическую поверхность.
Синтаксис, аргументы и результат
MOUSEY()Функция вызывается без аргументов.
Результат. Функция возвращает целое число типа LONG.
Описание MOUSEY: поведение, ограничения и примеры
Запускаемые примеры
MOVEDIR
MOVEDIR переносит каталог по новому пути.
Синтаксис, аргументы и результат
MOVEDIR(<источник>, <назначение>)| Аргумент | Что передать |
|---|---|
<источник> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка источника задаёт существующий каталог для переноса либо копирования. |
<назначение> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка назначения задаёт полный путь каталога назначения, включая его имя. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание MOVEDIR: поведение, ограничения и примеры
Запускаемые примеры
MOVEFILE
MOVEFILE переносит существующий файл по новому пути.
Синтаксис, аргументы и результат
MOVEFILE(<источник>, <назначение>)| Аргумент | Что передать |
|---|---|
<источник> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка источника задаёт существующий файл для переноса либо копирования. |
<назначение> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка назначения задаёт полный путь файла назначения, включая его имя. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
MOVEFILE(<источник>, <назначение>, <разрешение перезаписи>)| Аргумент | Что передать |
|---|---|
<источник> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка источника задаёт существующий файл для переноса либо копирования. |
<назначение> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка назначения задаёт полный путь файла назначения, включая его имя. |
<разрешение перезаписи> | Значение аргумента должно быть логическим значением типа BOOLEAN. имеет тип BOOLEAN. Логическое значение TRUE разрешает замену существующих файлов; FALSE запрещает её. Без этого аргумента действует FALSE. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание MOVEFILE: поведение, ограничения и примеры
Запускаемые примеры
NEWLINE
NEWLINE записывает символ LF в открытый файл.
Синтаксис, аргументы и результат
NEWLINE(<файл>)| Аргумент | Что передать |
|---|---|
<файл> | Значение аргумента должно быть значением открытого файла типа FILE. имеет тип FILE. Значение типа FILE обозначает ресурс, открытый оператором OPEN в режиме OUTPUT или APPEND. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание NEWLINE: поведение, ограничения и примеры
Запускаемые примеры
NOW
NOW возвращает текущую дату и время.
Синтаксис, аргументы и результат
NOW()Функция вызывается без аргументов.
Результат. Функция возвращает дату и время типа DATETIME.
NOW(<часовой пояс>)| Аргумент | Что передать |
|---|---|
<часовой пояс> | Значение аргумента должно быть строкой типа STRING. Укажите UTC, LOCAL или системный идентификатор пояса, в котором требуется получить текущие дату и время. |
Результат. Функция возвращает дату и время типа DATETIME.
Описание NOW: поведение, ограничения и примеры
Запускаемые примеры
NOWINSTANT
NOWINSTANT возвращает текущий момент времени на шкале UTC.
Синтаксис, аргументы и результат
NOWINSTANT()Функция вызывается без аргументов.
Результат. Функция возвращает момент времени типа UTCDATETIME.
Описание NOWINSTANT: поведение, ограничения и примеры
Запускаемые примеры
PADLEFT
PADLEFT возвращает строку, дополнив её слева до заданной ширины.
Синтаксис, аргументы и результат
PADLEFT(<текст>, <ширина>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<ширина> | Значение аргумента должно быть целым числом типа INTEGER. Передайте неотрицательное целое число типа INTEGER с минимальной длиной результата в кодовых единицах UTF-16. |
Результат. Функция возвращает строку типа STRING.
PADLEFT(<текст>, <ширина>, <заполнение>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<ширина> | Значение аргумента должно быть целым числом типа INTEGER. Передайте неотрицательное целое число типа INTEGER с минимальной длиной результата в кодовых единицах UTF-16. |
<заполнение> | Значение аргумента должно быть строкой типа STRING. Передайте непустую строку типа STRING с заполнителем. Используется первая кодовая единица UTF-16; без аргумента используется обычный пробел. |
Результат. Функция возвращает строку типа STRING.
Описание PADLEFT: поведение, ограничения и примеры
Запускаемые примеры
PADRIGHT
PADRIGHT возвращает строку, дополнив её справа до заданной ширины.
Синтаксис, аргументы и результат
PADRIGHT(<текст>, <ширина>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<ширина> | Значение аргумента должно быть целым числом типа INTEGER. Передайте неотрицательное целое число типа INTEGER с минимальной длиной результата в кодовых единицах UTF-16. |
Результат. Функция возвращает строку типа STRING.
PADRIGHT(<текст>, <ширина>, <заполнение>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<ширина> | Значение аргумента должно быть целым числом типа INTEGER. Передайте неотрицательное целое число типа INTEGER с минимальной длиной результата в кодовых единицах UTF-16. |
<заполнение> | Значение аргумента должно быть строкой типа STRING. Передайте непустую строку типа STRING с заполнителем. Используется первая кодовая единица UTF-16; без аргумента используется обычный пробел. |
Результат. Функция возвращает строку типа STRING.
Описание PADRIGHT: поведение, ограничения и примеры
Запускаемые примеры
PATHEXISTS
PATHEXISTS проверяет, существует ли файл или каталог по заданному пути.
Синтаксис, аргументы и результат
PATHEXISTS(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к файлу или каталогу. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание PATHEXISTS: поведение, ограничения и примеры
Запускаемые примеры
PATHROOT
PATHROOT возвращает корень полного пути.
Синтаксис, аргументы и результат
PATHROOT(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт строку пути, которую нужно разобрать или нормализовать. |
Результат. Функция возвращает строку типа STRING.
Описание PATHROOT: поведение, ограничения и примеры
Запускаемые примеры
PMAP
PMAP возвращает DOUBLE с преобразованной координатой SCREEN между логической шкалой WINDOW и пиксельной системой VIEW. Без WINDOW возвращает исходную координату.
Синтаксис, аргументы и результат
PMAP(<координата>, <функция преобразования>)| Аргумент | Что передать |
|---|---|
<координата> | Значение аргумента должно быть числом типа DOUBLE. Передайте конечное DOUBLE с координатой для преобразования. |
<функция преобразования> | Значение аргумента должно быть целым числом типа INTEGER. Передайте INTEGER: 0 — логический X в пиксельный, 1 — логический Y в пиксельный, 2 — пиксельный X в логический, 3 — пиксельный Y в логический. |
Результат. Функция возвращает число типа DOUBLE.
Описание PMAP: поведение, ограничения и примеры
Запускаемые примеры
POINT
POINT возвращает индекс цвета пикселя в заданной точке либо выбранную координату текущей графической позиции SCREEN.
Синтаксис, аргументы и результат
POINT(<число>)| Аргумент | Что передать |
|---|---|
<число> | Значение аргумента должно быть целым числом типа INTEGER. Укажите селектор координаты текущей графической позиции; эта одноаргументная форма применяется к SCREEN. |
Результат. Функция возвращает целое число типа INTEGER.
POINT(<x>, <y>)| Аргумент | Что передать |
|---|---|
<x> | Значение аргумента должно быть целым числом типа LONG. Укажите горизонтальную координату читаемой точки: для SCREEN учитываются VIEW и WINDOW, для CANVAS выбирается физический пиксель холста. |
<y> | Значение аргумента должно быть целым числом типа LONG. Укажите вертикальную координату читаемой точки в той же системе, что и горизонтальная координата. |
Результат. Функция возвращает целое число типа INTEGER.
Описание POINT: поведение, ограничения и примеры
Запускаемые примеры
POW
POW возвращает первое число в степени второго.
Синтаксис, аргументы и результат
POW(<значение>, <показатель степени>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Перед вычислением оно преобразуется в DOUBLE. Передайте основание степени, которое требуется возвести в степень. |
<показатель степени> | Передаётся числовое выражение. Перед вычислением оно преобразуется в DOUBLE. Передайте показатель степени, применяемый к основанию. |
Результат. Функция возвращает число типа DOUBLE.
Описание POW: поведение, ограничения и примеры
Запускаемые примеры
READALLLINES
READALLLINES читает строки файла в одномерный массив строк.
Синтаксис, аргументы и результат
READALLLINES(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к файлу. |
Результат. Функция возвращает одномерный массив строк типа STRING[].
READALLLINES(<путь>, <кодировка>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к файлу. |
<кодировка> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка кодировки выбирает UTF-8, WINDOWS-1251, UTF-16LE или UTF-16BE; регистр и крайние пробелы игнорируются. |
Результат. Функция возвращает одномерный массив строк типа STRING[].
Описание READALLLINES: поведение, ограничения и примеры
Запускаемые примеры
READFILE
READFILE читает весь текст файла в строку.
Синтаксис, аргументы и результат
READFILE(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к файлу. |
Результат. Функция возвращает строку типа STRING.
READFILE(<путь>, <кодировка>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к файлу. |
<кодировка> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка кодировки выбирает UTF-8, WINDOWS-1251, UTF-16LE или UTF-16BE; регистр и крайние пробелы игнорируются. |
Результат. Функция возвращает строку типа STRING.
Описание READFILE: поведение, ограничения и примеры
Запускаемые примеры
READLINE
READLINE читает одну строку открытого файла без её разделителя.
Синтаксис, аргументы и результат
READLINE(<файл>)| Аргумент | Что передать |
|---|---|
<файл> | Значение аргумента должно быть значением открытого файла типа FILE. имеет тип FILE. Значение типа FILE обозначает ресурс, открытый оператором OPEN в режиме INPUT. |
Результат. Функция возвращает строку типа STRING.
Описание READLINE: поведение, ограничения и примеры
Запускаемые примеры
READLINES
READLINES читает не более заданного числа строк открытого файла в массив.
Синтаксис, аргументы и результат
READLINES(<файл>, <количество>)| Аргумент | Что передать |
|---|---|
<файл> | Значение аргумента должно быть значением открытого файла типа FILE. имеет тип FILE. Значение типа FILE обозначает ресурс, открытый оператором OPEN в режиме INPUT. |
<количество> | Значение аргумента должно быть целым числом типа INTEGER. имеет тип INTEGER. Целое число INTEGER задаёт максимальное число читаемых строк. Ноль возвращает пустой результат и не сдвигает позицию; отрицательное число недопустимо. |
Результат. Функция возвращает одномерный массив строк типа STRING[].
Описание READLINES: поведение, ограничения и примеры
Запускаемые примеры
READTEXT
READTEXT читает не более заданного числа скалярных значений Unicode.
Синтаксис, аргументы и результат
READTEXT(<файл>, <количество>)| Аргумент | Что передать |
|---|---|
<файл> | Значение аргумента должно быть значением открытого файла типа FILE. имеет тип FILE. Значение типа FILE обозначает ресурс, открытый оператором OPEN в режиме INPUT. |
<количество> | Значение аргумента должно быть целым числом типа INTEGER. имеет тип INTEGER. Целое число INTEGER задаёт максимальное число читаемых скалярных значений Unicode. Ноль возвращает пустой результат и не сдвигает позицию; отрицательное число недопустимо. |
Результат. Функция возвращает строку типа STRING.
Описание READTEXT: поведение, ограничения и примеры
Запускаемые примеры
READTOEND
READTOEND читает оставшийся текст открытого файла в строку.
Синтаксис, аргументы и результат
READTOEND(<файл>)| Аргумент | Что передать |
|---|---|
<файл> | Значение аргумента должно быть значением открытого файла типа FILE. имеет тип FILE. Значение типа FILE обозначает ресурс, открытый оператором OPEN в режиме INPUT. |
Результат. Функция возвращает строку типа STRING.
Описание READTOEND: поведение, ограничения и примеры
Запускаемые примеры
REGEXCOUNT
REGEXCOUNT возвращает количество совпадений с регулярным выражением.
Синтаксис, аргументы и результат
REGEXCOUNT(<текст>, <шаблон>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте текст, в котором требуется подсчитать совпадения. |
<шаблон> | Значение аргумента должно быть строкой типа STRING. Укажите регулярное выражение, определяющее подсчитываемые совпадения. |
Результат. Функция возвращает целое число типа INTEGER.
REGEXCOUNT(<текст>, <шаблон>, <режимы>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте текст, в котором требуется подсчитать совпадения. |
<шаблон> | Значение аргумента должно быть строкой типа STRING. Укажите регулярное выражение, определяющее подсчитываемые совпадения. |
<режимы> | Значение аргумента должно быть строкой типа STRING. Укажите строку режимов регулярного выражения, изменяющих правила поиска; без аргумента применяются обычные правила. |
Результат. Функция возвращает целое число типа INTEGER.
Описание REGEXCOUNT: поведение, ограничения и примеры
Запускаемые примеры
REGEXEXTRACT
REGEXEXTRACT возвращает значение выбранной группы первого совпадения с регулярным выражением.
Синтаксис, аргументы и результат
REGEXEXTRACT(<текст>, <шаблон>, <номер группы>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте текст, в котором требуется найти первое совпадение и извлечь группу. |
<шаблон> | Значение аргумента должно быть строкой типа STRING. Укажите регулярное выражение с группой, текст которой требуется получить. |
<номер группы> | Значение аргумента должно быть целым числом типа INTEGER. Укажите номер извлекаемой группы первого совпадения. |
Результат. Функция возвращает строку типа STRING.
REGEXEXTRACT(<текст>, <шаблон>, <номер группы>, <режимы>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте текст, в котором требуется найти первое совпадение и извлечь группу. |
<шаблон> | Значение аргумента должно быть строкой типа STRING. Укажите регулярное выражение с группой, текст которой требуется получить. |
<номер группы> | Значение аргумента должно быть целым числом типа INTEGER. Укажите номер извлекаемой группы первого совпадения. |
<режимы> | Значение аргумента должно быть строкой типа STRING. Укажите строку режимов регулярного выражения, применяемых при поиске первого совпадения. |
Результат. Функция возвращает строку типа STRING.
Описание REGEXEXTRACT: поведение, ограничения и примеры
Запускаемые примеры
REGEXEXTRACTALL
REGEXEXTRACTALL возвращает значения выбранной группы для всех совпадений с регулярным выражением как массив строк.
Синтаксис, аргументы и результат
REGEXEXTRACTALL(<текст>, <шаблон>, <номер группы>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте текст, из совпадений которого требуется получить значения группы. |
<шаблон> | Значение аргумента должно быть строкой типа STRING. Укажите регулярное выражение с группой, извлекаемой из каждого совпадения. |
<номер группы> | Значение аргумента должно быть целым числом типа INTEGER. Укажите номер группы, значение которой требуется взять из всех совпадений. |
Результат. Функция возвращает одномерный массив строк типа STRING[].
REGEXEXTRACTALL(<текст>, <шаблон>, <номер группы>, <режимы>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте текст, из совпадений которого требуется получить значения группы. |
<шаблон> | Значение аргумента должно быть строкой типа STRING. Укажите регулярное выражение с группой, извлекаемой из каждого совпадения. |
<номер группы> | Значение аргумента должно быть целым числом типа INTEGER. Укажите номер группы, значение которой требуется взять из всех совпадений. |
<режимы> | Значение аргумента должно быть строкой типа STRING. Укажите строку режимов регулярного выражения для поиска всех совпадений. |
Результат. Функция возвращает одномерный массив строк типа STRING[].
Описание REGEXEXTRACTALL: поведение, ограничения и примеры
Запускаемые примеры
REGEXISMATCH
REGEXISMATCH проверяет, содержит ли текст хотя бы одно совпадение с регулярным выражением.
Синтаксис, аргументы и результат
REGEXISMATCH(<текст>, <шаблон>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте текст, в котором требуется проверить наличие совпадения. |
<шаблон> | Значение аргумента должно быть строкой типа STRING. Укажите регулярное выражение, наличие совпадения с которым проверяется. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
REGEXISMATCH(<текст>, <шаблон>, <режимы>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте текст, в котором требуется проверить наличие совпадения. |
<шаблон> | Значение аргумента должно быть строкой типа STRING. Укажите регулярное выражение, наличие совпадения с которым проверяется. |
<режимы> | Значение аргумента должно быть строкой типа STRING. Укажите строку режимов регулярного выражения для проверки совпадения. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание REGEXISMATCH: поведение, ограничения и примеры
Запускаемые примеры
REGEXMATCH
REGEXMATCH возвращает текст первого полного совпадения с регулярным выражением.
Синтаксис, аргументы и результат
REGEXMATCH(<текст>, <шаблон>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте текст, из которого требуется получить первое совпадение. |
<шаблон> | Значение аргумента должно быть строкой типа STRING. Укажите регулярное выражение, определяющее искомый фрагмент. |
Результат. Функция возвращает строку типа STRING.
REGEXMATCH(<текст>, <шаблон>, <режимы>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте текст, из которого требуется получить первое совпадение. |
<шаблон> | Значение аргумента должно быть строкой типа STRING. Укажите регулярное выражение, определяющее искомый фрагмент. |
<режимы> | Значение аргумента должно быть строкой типа STRING. Укажите строку режимов регулярного выражения для поиска первого совпадения. |
Результат. Функция возвращает строку типа STRING.
Описание REGEXMATCH: поведение, ограничения и примеры
Запускаемые примеры
REGEXMATCHES
REGEXMATCHES возвращает все найденные совпадения с регулярным выражением как массив строк.
Синтаксис, аргументы и результат
REGEXMATCHES(<текст>, <шаблон>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте текст, из которого требуется собрать все совпадения. |
<шаблон> | Значение аргумента должно быть строкой типа STRING. Укажите регулярное выражение, определяющее элементы возвращаемого массива. |
Результат. Функция возвращает одномерный массив строк типа STRING[].
REGEXMATCHES(<текст>, <шаблон>, <режимы>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте текст, из которого требуется собрать все совпадения. |
<шаблон> | Значение аргумента должно быть строкой типа STRING. Укажите регулярное выражение, определяющее элементы возвращаемого массива. |
<режимы> | Значение аргумента должно быть строкой типа STRING. Укажите строку режимов регулярного выражения для поиска всех совпадений. |
Результат. Функция возвращает одномерный массив строк типа STRING[].
Описание REGEXMATCHES: поведение, ограничения и примеры
Запускаемые примеры
REGEXREPLACE
REGEXREPLACE заменяет совпадения с регулярным выражением и возвращает полученную строку.
Синтаксис, аргументы и результат
REGEXREPLACE(<текст>, <шаблон>, <замена>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходный текст, в котором требуется выполнить замены. |
<шаблон> | Значение аргумента должно быть строкой типа STRING. Укажите регулярное выражение, определяющее заменяемые фрагменты. |
<замена> | Значение аргумента должно быть строкой типа STRING. Передайте текст замены; в нём допускаются ссылки на группы, например $1 и $2. |
Результат. Функция возвращает строку типа STRING.
REGEXREPLACE(<текст>, <шаблон>, <замена>, <режимы>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходный текст, в котором требуется выполнить замены. |
<шаблон> | Значение аргумента должно быть строкой типа STRING. Укажите регулярное выражение, определяющее заменяемые фрагменты. |
<замена> | Значение аргумента должно быть строкой типа STRING. Передайте текст замены; в нём допускаются ссылки на группы, например $1 и $2. |
<режимы> | Значение аргумента должно быть строкой типа STRING. Укажите строку режимов регулярного выражения для поиска заменяемых совпадений. |
Результат. Функция возвращает строку типа STRING.
REGEXREPLACE(<текст>, <шаблон>, <замена>, <количество>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходный текст, в котором требуется выполнить замены. |
<шаблон> | Значение аргумента должно быть строкой типа STRING. Укажите регулярное выражение, определяющее заменяемые фрагменты. |
<замена> | Значение аргумента должно быть строкой типа STRING. Передайте текст замены; в нём допускаются ссылки на группы, например $1 и $2. |
<количество> | Значение аргумента должно быть целым числом типа INTEGER. Укажите неотрицательный предел числа первых замен; ноль возвращает исходный текст, а без предела заменяются все совпадения. |
Результат. Функция возвращает строку типа STRING.
REGEXREPLACE(<текст>, <шаблон>, <замена>, <режимы>, <количество>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходный текст, в котором требуется выполнить замены. |
<шаблон> | Значение аргумента должно быть строкой типа STRING. Укажите регулярное выражение, определяющее заменяемые фрагменты. |
<замена> | Значение аргумента должно быть строкой типа STRING. Передайте текст замены; в нём допускаются ссылки на группы, например $1 и $2. |
<режимы> | Значение аргумента должно быть строкой типа STRING. Укажите строку режимов регулярного выражения для поиска заменяемых совпадений. |
<количество> | Значение аргумента должно быть целым числом типа INTEGER. Укажите неотрицательный предел числа первых замен; ноль возвращает исходный текст, а без предела заменяются все совпадения. |
Результат. Функция возвращает строку типа STRING.
Описание REGEXREPLACE: поведение, ограничения и примеры
Запускаемые примеры
REGEXSPLIT
REGEXSPLIT разбивает текст по совпадениям с регулярным выражением и возвращает полученные части как массив строк.
Синтаксис, аргументы и результат
REGEXSPLIT(<текст>, <шаблон>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте текст, который требуется разделить на части. |
<шаблон> | Значение аргумента должно быть строкой типа STRING. Укажите регулярное выражение, совпадения которого служат разделителями. |
Результат. Функция возвращает одномерный массив строк типа STRING[].
REGEXSPLIT(<текст>, <шаблон>, <режимы>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте текст, который требуется разделить на части. |
<шаблон> | Значение аргумента должно быть строкой типа STRING. Укажите регулярное выражение, совпадения которого служат разделителями. |
<режимы> | Значение аргумента должно быть строкой типа STRING. Укажите строку режимов регулярного выражения для распознавания разделителей. |
Результат. Функция возвращает одномерный массив строк типа STRING[].
Описание REGEXSPLIT: поведение, ограничения и примеры
Запускаемые примеры
REMOVE
REMOVE возвращает строку, удалив заданное количество единиц текста с указанной позиции.
Синтаксис, аргументы и результат
REMOVE(<текст>, <начальная позиция>, <количество>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<начальная позиция> | Значение аргумента должно быть целым числом типа INTEGER. Передайте целое число типа INTEGER с начальной позицией. Позиции отсчитываются от 1. |
<количество> | Значение аргумента должно быть целым числом типа INTEGER. Передайте неотрицательное целое число типа INTEGER с количеством удаляемых кодовых единиц UTF-16. |
Результат. Функция возвращает строку типа STRING.
Описание REMOVE: поведение, ограничения и примеры
Запускаемые примеры
RENAMEDIR
RENAMEDIR меняет имя каталога внутри его родительского каталога.
Синтаксис, аргументы и результат
RENAMEDIR(<путь>, <новое имя>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к каталогу. |
<новое имя> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка нового имени задаёт только имя без пути; пустое имя, . и .. недопустимы. Родительский каталог сохраняется. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание RENAMEDIR: поведение, ограничения и примеры
Запускаемые примеры
RENAMEFILE
RENAMEFILE меняет имя файла в его текущем каталоге.
Синтаксис, аргументы и результат
RENAMEFILE(<путь>, <новое имя>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к файлу. |
<новое имя> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка нового имени задаёт только имя без пути; пустое имя, . и .. недопустимы. Родительский каталог сохраняется. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание RENAMEFILE: поведение, ограничения и примеры
Запускаемые примеры
REPEAT
REPEAT возвращает строку, повторив исходный фрагмент указанное число раз.
Синтаксис, аргументы и результат
REPEAT(<текст>, <количество>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<количество> | Значение аргумента должно быть целым числом типа INTEGER. Передайте неотрицательное целое число типа INTEGER с количеством повторений. |
Результат. Функция возвращает строку типа STRING.
Описание REPEAT: поведение, ограничения и примеры
Запускаемые примеры
REPLACE
REPLACE возвращает строку, заменив все точные вхождения одного фрагмента другим.
Синтаксис, аргументы и результат
REPLACE(<текст>, <исходный текст>, <новый текст>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<исходный текст> | Значение аргумента должно быть строкой типа STRING. Передайте непустую строку типа STRING с заменяемым фрагментом. |
<новый текст> | Значение аргумента должно быть строкой типа STRING. Передайте строку типа STRING с текстом замены. Пустая строка удаляет найденные фрагменты. |
Результат. Функция возвращает строку типа STRING.
Описание REPLACE: поведение, ограничения и примеры
Запускаемые примеры
REPLACEMANY
REPLACEMANY возвращает строку после одновременной замены нескольких фрагментов по двум массивам правил.
Синтаксис, аргументы и результат
REPLACEMANY(<текст>, <исходные элементы>, <новые элементы>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<исходные элементы> | Допустимый тип значения: STRING[]. Передайте одномерный массив строк STRING[] с заменяемыми непустыми фрагментами. |
<новые элементы> | Допустимый тип значения: STRING[]. Передайте одномерный массив строк STRING[] с соответствующими заменами. Длина должна совпадать с длиной массива исходных фрагментов; нижние границы могут различаться. |
Результат. Функция возвращает строку типа STRING.
Описание REPLACEMANY: поведение, ограничения и примеры
Запускаемые примеры
REVERSE
REVERSE возвращает строку с обратным порядком кодов Unicode.
Синтаксис, аргументы и результат
REVERSE(<текст>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
Результат. Функция возвращает строку типа STRING.
Описание REVERSE: поведение, ограничения и примеры
Запускаемые примеры
REWIND
REWIND переставляет позицию открытого файла в начало содержимого.
Синтаксис, аргументы и результат
REWIND(<файл>)| Аргумент | Что передать |
|---|---|
<файл> | Значение аргумента должно быть значением открытого файла типа FILE. имеет тип FILE. Значение типа FILE обозначает ресурс, открытый оператором OPEN в режиме INPUT или OUTPUT. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание REWIND: поведение, ограничения и примеры
Запускаемые примеры
RGB
RGB собирает полноцветное значение 0xRRGGBB из красной, зелёной и синей составляющих.
Синтаксис, аргументы и результат
RGB(<красный>, <зелёный>, <синий>)| Аргумент | Что передать |
|---|---|
<красный> | Значение аргумента должно быть целым числом типа LONG. Укажите интенсивность красной составляющей цвета от 0 до 255. |
<зелёный> | Значение аргумента должно быть целым числом типа LONG. Укажите интенсивность зелёной составляющей цвета от 0 до 255. |
<синий> | Значение аргумента должно быть целым числом типа LONG. Укажите интенсивность синей составляющей цвета от 0 до 255. |
Результат. Функция возвращает целое число типа INTEGER.
Описание RGB: поведение, ограничения и примеры
Запускаемые примеры
RIGHT
RIGHT возвращает фрагмент заданной длины из конца строки.
Синтаксис, аргументы и результат
RIGHT(<текст>, <количество>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<количество> | Значение аргумента должно быть целым числом типа INTEGER. Передайте целое число типа INTEGER, задающее количество единиц текста. Значение должно быть больше нуля. |
Результат. Функция возвращает строку типа STRING.
RIGHT(<текст>, <количество>, <единица измерения>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<количество> | Значение аргумента должно быть целым числом типа INTEGER. Передайте целое число типа INTEGER, задающее количество единиц текста. Значение должно быть больше нуля. |
<единица измерения> | Значение аргумента должно быть строкой типа STRING. Передайте строку типа STRING: "UTF16", "CODEPOINT" или "GRAPHEME". Регистр букв несущественен, пробелы не удаляются. Без этого аргумента используется UTF16. |
Результат. Функция возвращает строку типа STRING.
Описание RIGHT: поведение, ограничения и примеры
Запускаемые примеры
RND
RND возвращает очередное псевдослучайное число.
Синтаксис, аргументы и результат
RND()Функция вызывается без аргументов.
Результат. Функция возвращает число типа DOUBLE.
Описание RND: поведение, ограничения и примеры
Запускаемые примеры
ROUND
ROUND возвращает число, округлённое до ближайшего целого.
Синтаксис, аргументы и результат
ROUND(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Допустимые числовые типы и результат описаны ниже. Передайте округляемое число; например, половина между 2 и 3 округляется к 3, между -2 и -3 — к -3. |
Результат. Функция возвращает значение того же числового типа, что и первый аргумент.
Описание ROUND: поведение, ограничения и примеры
Запускаемые примеры
RTRIM
RTRIM возвращает строку после удаления заданных символов с конца текста.
Синтаксис, аргументы и результат
RTRIM(<текст>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
Результат. Функция возвращает строку типа STRING.
RTRIM(<текст>, <символы>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<символы> | Значение аргумента должно быть строкой типа STRING. Передайте строку типа STRING, перечисляющую удаляемые кодовые единицы UTF-16. Это набор отдельных символов, а не подстрока. Если аргумент отсутствует, удаляются пробельные символы, распознаваемые .NET. |
Результат. Функция возвращает строку типа STRING.
Описание RTRIM: поведение, ограничения и примеры
Запускаемые примеры
SCREENHEIGHT
SCREENHEIGHT возвращает INTEGER с высотой текущей поверхности SCREEN или CANVAS в пикселях. Без открытой поверхности возвращает 0.
Синтаксис, аргументы и результат
SCREENHEIGHT()Функция вызывается без аргументов.
Результат. Функция возвращает целое число типа INTEGER.
Описание SCREENHEIGHT: поведение, ограничения и примеры
Запускаемые примеры
SCREENISACTIVE
SCREENISACTIVE возвращает BOOLEAN: TRUE только при активном графическом SCREEN 1..10; для SCREEN 0, CANVAS и отсутствующей поверхности возвращает FALSE.
Синтаксис, аргументы и результат
SCREENISACTIVE()Функция вызывается без аргументов.
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание SCREENISACTIVE: поведение, ограничения и примеры
Запускаемые примеры
SCREENMODE
SCREENMODE возвращает INTEGER с номером текущего режима SCREEN. Без SCREEN, в текстовом режиме и на CANVAS возвращает 0.
Синтаксис, аргументы и результат
SCREENMODE()Функция вызывается без аргументов.
Результат. Функция возвращает целое число типа INTEGER.
Описание SCREENMODE: поведение, ограничения и примеры
Запускаемые примеры
SCREENWIDTH
SCREENWIDTH возвращает INTEGER с шириной текущей поверхности SCREEN или CANVAS в пикселях. Без открытой поверхности возвращает 0.
Синтаксис, аргументы и результат
SCREENWIDTH()Функция вызывается без аргументов.
Результат. Функция возвращает целое число типа INTEGER.
Описание SCREENWIDTH: поведение, ограничения и примеры
Запускаемые примеры
SECOND
SECOND возвращает секунду внутри минуты.
Синтаксис, аргументы и результат
SECOND(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть временем суток типа TIME. Передайте значение времени, из которого требуется извлечь секунды. |
Результат. Функция возвращает целое число типа INTEGER.
Описание SECOND: поведение, ограничения и примеры
Запускаемые примеры
SEEKFILE
SEEKFILE переставляет текущую позицию открытого файла на заданное байтовое смещение.
Синтаксис, аргументы и результат
SEEKFILE(<файл>, <позиция>)| Аргумент | Что передать |
|---|---|
<файл> | Значение аргумента должно быть значением открытого файла типа FILE. имеет тип FILE. Значение типа FILE обозначает ресурс, открытый оператором OPEN в режиме INPUT или OUTPUT. |
<позиция> | Значение аргумента должно быть целым числом типа LONG. имеет тип LONG. Целое число LONG задаёт байтовое смещение от начала содержимого, без распознанного BOM; допустим диапазон от 0 до FILELENGTH(файл) включительно. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание SEEKFILE: поведение, ограничения и примеры
Запускаемые примеры
SETSIGN
SETSIGN возвращает модуль первого числа со знаком второго числа.
Синтаксис, аргументы и результат
SETSIGN(<значение>, <источник знака>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Допустимые числовые типы и результат описаны ниже. Передайте число, величину которого требуется сохранить в результате. |
<источник знака> | Передаётся числовое выражение. Допустимые числовые типы и результат описаны ниже. Передайте число, знак которого требуется перенести на величину первого аргумента. |
Результат. Функция возвращает значение того же числового типа, что и первый аргумент.
Описание SETSIGN: поведение, ограничения и примеры
Запускаемые примеры
SGN
SGN возвращает знак числа в виде −1, 0 или 1.
Синтаксис, аргументы и результат
SGN(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Допустимые числовые типы и результат описаны ниже. Передайте число, знак которого требуется определить сравнением с нулём. |
Результат. Функция возвращает целое число типа INTEGER.
Описание SGN: поведение, ограничения и примеры
Запускаемые примеры
SIN
SIN возвращает синус угла.
Синтаксис, аргументы и результат
SIN(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Перед вычислением оно преобразуется в DOUBLE. Укажите угол в радианах, синус которого требуется вычислить. |
Результат. Функция возвращает число типа DOUBLE.
Описание SIN: поведение, ограничения и примеры
Запускаемые примеры
SINH
SINH возвращает гиперболический синус числа.
Синтаксис, аргументы и результат
SINH(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Перед вычислением оно преобразуется в DOUBLE. Передайте число, для которого требуется вычислить гиперболический синус. |
Результат. Функция возвращает число типа DOUBLE.
Описание SINH: поведение, ограничения и примеры
Запускаемые примеры
SKIPLINE
SKIPLINE пропускает одну строку открытого файла.
Синтаксис, аргументы и результат
SKIPLINE(<файл>)| Аргумент | Что передать |
|---|---|
<файл> | Значение аргумента должно быть значением открытого файла типа FILE. имеет тип FILE. Значение типа FILE обозначает ресурс, открытый оператором OPEN в режиме INPUT. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание SKIPLINE: поведение, ограничения и примеры
Запускаемые примеры
SPACE
SPACE возвращает строку из указанного количества пробелов.
Синтаксис, аргументы и результат
SPACE(<количество>)| Аргумент | Что передать |
|---|---|
<количество> | Значение аргумента должно быть целым числом типа INTEGER. Передайте неотрицательное целое число типа INTEGER с количеством обычных пробелов U+0020. |
Результат. Функция возвращает строку типа STRING.
Описание SPACE: поведение, ограничения и примеры
Запускаемые примеры
SPLIT
SPLIT разбивает строку по разделителю и возвращает массив полученных частей.
Синтаксис, аргументы и результат
SPLIT(<текст>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
Результат. Функция возвращает одномерный массив строк типа STRING[].
SPLIT(<текст>, <разделитель>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<разделитель> | Значение аргумента должно быть строкой типа STRING. Передайте непустую строку типа STRING с точным разделителем. Без этого аргумента используется запятая. |
Результат. Функция возвращает одномерный массив строк типа STRING[].
Описание SPLIT: поведение, ограничения и примеры
Запускаемые примеры
SPRITECOUNT
SPRITECOUNT возвращает число полных кадров в переданном спрайтовом листе.
Синтаксис, аргументы и результат
SPRITECOUNT(<спрайт>)| Аргумент | Что передать |
|---|---|
<спрайт> | Значение аргумента должно быть спрайтом типа SPRITE. Передайте спрайт, количество полных кадров которого требуется узнать. |
Результат. Функция возвращает целое число типа INTEGER.
Описание SPRITECOUNT: поведение, ограничения и примеры
Запускаемые примеры
SPRITEHEIGHT
SPRITEHEIGHT возвращает высоту одного кадра переданного спрайта в пикселях.
Синтаксис, аргументы и результат
SPRITEHEIGHT(<спрайт>)| Аргумент | Что передать |
|---|---|
<спрайт> | Значение аргумента должно быть спрайтом типа SPRITE. Передайте спрайт, высоту кадра которого требуется узнать. |
Результат. Функция возвращает целое число типа INTEGER.
Описание SPRITEHEIGHT: поведение, ограничения и примеры
Запускаемые примеры
SPRITEWIDTH
SPRITEWIDTH возвращает ширину одного кадра переданного спрайта в пикселях.
Синтаксис, аргументы и результат
SPRITEWIDTH(<спрайт>)| Аргумент | Что передать |
|---|---|
<спрайт> | Значение аргумента должно быть спрайтом типа SPRITE. Передайте спрайт, ширину кадра которого требуется узнать. |
Результат. Функция возвращает целое число типа INTEGER.
Описание SPRITEWIDTH: поведение, ограничения и примеры
Запускаемые примеры
SQR
SQR возвращает квадратный корень числа.
Синтаксис, аргументы и результат
SQR(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Перед вычислением оно преобразуется в DOUBLE. Передайте неотрицательное число, квадратный корень которого требуется получить. |
Результат. Функция возвращает число типа DOUBLE.
Описание SQR: поведение, ограничения и примеры
Запускаемые примеры
STARTOFMONTH
STARTOFMONTH возвращает первый день месяца исходной даты.
Синтаксис, аргументы и результат
STARTOFMONTH(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть датой типа DATE. Передайте дату, начало месяца которой требуется получить. |
Результат. Функция возвращает дату типа DATE.
Описание STARTOFMONTH: поведение, ограничения и примеры
Запускаемые примеры
STARTOFYEAR
STARTOFYEAR возвращает первый день года исходной даты.
Синтаксис, аргументы и результат
STARTOFYEAR(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть датой типа DATE. Передайте дату, начало года которой требуется получить. |
Результат. Функция возвращает дату типа DATE.
Описание STARTOFYEAR: поведение, ограничения и примеры
Запускаемые примеры
STARTSWITH
STARTSWITH проверяет, начинается ли строка с указанного фрагмента.
Синтаксис, аргументы и результат
STARTSWITH(<текст>, <фрагмент>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<фрагмент> | Значение аргумента должно быть строкой типа STRING. Передайте строку типа STRING, которую требуется найти в исходном тексте. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание STARTSWITH: поведение, ограничения и примеры
Запускаемые примеры
STR
STR возвращает строковую запись числа.
Синтаксис, аргументы и результат
STR(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Допустимые числовые типы и результат описаны ниже. Передайте число, текстовое представление которого требуется получить. |
Результат. Функция возвращает строку типа STRING.
Описание STR: поведение, ограничения и примеры
Запускаемые примеры
STRING
STRING возвращает строку, повторив первую кодовую единицу заполнителя указанное число раз.
Синтаксис, аргументы и результат
STRING(<количество>, <заполнение>)| Аргумент | Что передать |
|---|---|
<количество> | Значение аргумента должно быть целым числом типа INTEGER. Передайте неотрицательное целое число типа INTEGER с количеством повторений. |
<заполнение> | Значение аргумента должно быть строкой типа STRING. Передайте строку типа STRING с заполнителем. При положительном количестве она должна быть непустой. Используется только её первая кодовая единица UTF-16. |
Результат. Функция возвращает строку типа STRING.
Описание STRING: поведение, ограничения и примеры
Запускаемые примеры
SUBSTRCOUNT
SUBSTRCOUNT возвращает количество неперекрывающихся вхождений фрагмента в строку.
Синтаксис, аргументы и результат
SUBSTRCOUNT(<текст>, <фрагмент>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<фрагмент> | Значение аргумента должно быть строкой типа STRING. Передайте непустую строку типа STRING с подсчитываемым фрагментом. |
Результат. Функция возвращает целое число типа INTEGER.
Описание SUBSTRCOUNT: поведение, ограничения и примеры
Запускаемые примеры
TAN
TAN возвращает тангенс угла.
Синтаксис, аргументы и результат
TAN(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Перед вычислением оно преобразуется в DOUBLE. Укажите угол в радианах, тангенс которого требуется вычислить. |
Результат. Функция возвращает число типа DOUBLE.
Описание TAN: поведение, ограничения и примеры
Запускаемые примеры
TANH
TANH возвращает гиперболический тангенс числа.
Синтаксис, аргументы и результат
TANH(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Передаётся числовое выражение. Перед вычислением оно преобразуется в DOUBLE. Передайте число, для которого требуется вычислить гиперболический тангенс. |
Результат. Функция возвращает число типа DOUBLE.
Описание TANH: поведение, ограничения и примеры
Запускаемые примеры
TEXTHEIGHT
TEXTHEIGHT возвращает INTEGER с высотой текста DRAWTEXT в пикселях: число строк умножается на 12. Каждая LF добавляет строку; для пустой строки возвращает 12. Требует CANVAS.
Синтаксис, аргументы и результат
TEXTHEIGHT(<текст>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте STRING с текстом, высоту которого требуется измерить. |
Результат. Функция возвращает целое число типа INTEGER.
Описание TEXTHEIGHT: поведение, ограничения и примеры
Запускаемые примеры
TEXTWIDTH
TEXTWIDTH возвращает INTEGER с шириной самой длинной строки в пикселях при рисовании DRAWTEXT на CANVAS. Каждая единица UTF-16 занимает 8 пикселей; CR пропускается, LF разделяет строки. Для пустой строки возвращает 0. Требует CANVAS.
Синтаксис, аргументы и результат
TEXTWIDTH(<текст>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте STRING с текстом, ширину которого требуется измерить. |
Результат. Функция возвращает целое число типа INTEGER.
Описание TEXTWIDTH: поведение, ограничения и примеры
Запускаемые примеры
TILECOUNT
TILECOUNT возвращает число тайлов в переданном наборе.
Синтаксис, аргументы и результат
TILECOUNT(<набор тайлов>)| Аргумент | Что передать |
|---|---|
<набор тайлов> | Значение аргумента должно быть набором тайлов типа TILESET. Передайте набор тайлов, количество элементов которого требуется узнать. |
Результат. Функция возвращает целое число типа INTEGER.
Описание TILECOUNT: поведение, ограничения и примеры
Запускаемые примеры
TILEHEIGHT
TILEHEIGHT возвращает высоту одного тайла переданного набора в пикселях.
Синтаксис, аргументы и результат
TILEHEIGHT(<набор тайлов>)| Аргумент | Что передать |
|---|---|
<набор тайлов> | Значение аргумента должно быть набором тайлов типа TILESET. Передайте набор тайлов, высоту одного элемента которого требуется узнать. |
Результат. Функция возвращает целое число типа INTEGER.
Описание TILEHEIGHT: поведение, ограничения и примеры
Запускаемые примеры
TILEWIDTH
TILEWIDTH возвращает ширину одного тайла переданного набора в пикселях.
Синтаксис, аргументы и результат
TILEWIDTH(<набор тайлов>)| Аргумент | Что передать |
|---|---|
<набор тайлов> | Значение аргумента должно быть набором тайлов типа TILESET. Передайте набор тайлов, ширину одного элемента которого требуется узнать. |
Результат. Функция возвращает целое число типа INTEGER.
Описание TILEWIDTH: поведение, ограничения и примеры
Запускаемые примеры
TIME
TIME возвращает текущее время суток.
Синтаксис, аргументы и результат
TIME()Функция вызывается без аргументов.
Результат. Функция возвращает время суток типа TIME.
TIME(<часовой пояс>)| Аргумент | Что передать |
|---|---|
<часовой пояс> | Значение аргумента должно быть строкой типа STRING. Укажите UTC, LOCAL или системный идентификатор пояса, время суток которого требуется получить. |
Результат. Функция возвращает время суток типа TIME.
Описание TIME: поведение, ограничения и примеры
Запускаемые примеры
TIMER
TIMER возвращает число секунд, прошедших с местной полуночи.
Синтаксис, аргументы и результат
TIMER()Функция вызывается без аргументов.
Результат. Функция возвращает число типа DOUBLE.
Описание TIMER: поведение, ограничения и примеры
Запускаемые примеры
TIMESERIAL
TIMESERIAL возвращает время суток, собранное из часа, минуты и секунды.
Синтаксис, аргументы и результат
TIMESERIAL(<час>, <минута>, <секунда>)| Аргумент | Что передать |
|---|---|
<час> | Значение аргумента должно быть целым числом типа INTEGER. Укажите часы от 0 до 23; переполненные компоненты не переносятся в следующие сутки. |
<минута> | Значение аргумента должно быть целым числом типа INTEGER. Укажите минуты от 0 до 59. |
<секунда> | Значение аргумента должно быть целым числом типа INTEGER. Укажите секунды от 0 до 59. |
Результат. Функция возвращает время суток типа TIME.
Описание TIMESERIAL: поведение, ограничения и примеры
Запускаемые примеры
TIMEVALUE
TIMEVALUE возвращает время суток, прочитанное из строки или взятое из значения DATETIME.
Синтаксис, аргументы и результат
TIMEVALUE(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть строкой типа STRING. Передайте строку вида HH:mm:ss или yyyy-MM-dd HH:mm:ss либо значение DATETIME. Допускается дробная часть секунд. Результат содержит только время суток вместе с долями секунды, поэтому календарная дата в него не входит. |
Результат. Функция возвращает время суток типа TIME.
TIMEVALUE(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть датой и временем типа DATETIME. Передайте строку вида HH:mm:ss или yyyy-MM-dd HH:mm:ss либо значение DATETIME. Допускается дробная часть секунд. Результат содержит только время суток вместе с долями секунды, поэтому календарная дата в него не входит. |
Результат. Функция возвращает время суток типа TIME.
Описание TIMEVALUE: поведение, ограничения и примеры
Запускаемые примеры
TOINSTANT
TOINSTANT возвращает момент времени, соответствующий календарной дате-времени в заданном поясе.
Синтаксис, аргументы и результат
TOINSTANT(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть датой и временем типа DATETIME. Передайте значение DATETIME, прочитанное как местное время. Пропущенное или повторяющееся время перехода часов недопустимо. |
Результат. Функция возвращает момент времени типа UTCDATETIME.
TOINSTANT(<значение>, <часовой пояс>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть датой и временем типа DATETIME. Передайте значение DATETIME, прочитанное как местное время. Пропущенное или повторяющееся время перехода часов недопустимо. |
<часовой пояс> | Значение аргумента должно быть строкой типа STRING. Укажите UTC, LOCAL или системный идентификатор пояса, в котором записано значение. |
Результат. Функция возвращает момент времени типа UTCDATETIME.
Описание TOINSTANT: поведение, ограничения и примеры
Запускаемые примеры
TOTALFREESPACE
TOTALFREESPACE возвращает общее число свободных байтов диска.
Синтаксис, аргументы и результат
TOTALFREESPACE(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь, по корню которого выбирается диск. |
Результат. Функция возвращает целое число типа LONG.
Описание TOTALFREESPACE: поведение, ограничения и примеры
Запускаемые примеры
TOTALSPACE
TOTALSPACE возвращает полную ёмкость диска в байтах.
Синтаксис, аргументы и результат
TOTALSPACE(<путь>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь, по корню которого выбирается диск. |
Результат. Функция возвращает целое число типа LONG.
Описание TOTALSPACE: поведение, ограничения и примеры
Запускаемые примеры
TOUTC
TOUTC возвращает дату и время, преобразованные из выбранного пояса в UTC.
Синтаксис, аргументы и результат
TOUTC(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть датой и временем типа DATETIME. Передайте дату и время, которые считаются временем исходного часового пояса. |
Результат. Функция возвращает дату и время типа DATETIME.
TOUTC(<значение>, <часовой пояс>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть датой и временем типа DATETIME. Передайте дату и время, которые считаются временем исходного часового пояса. |
<часовой пояс> | Значение аргумента должно быть строкой типа STRING. Укажите UTC, LOCAL или системный идентификатор исходного пояса; без аргумента используется местный пояс. |
Результат. Функция возвращает дату и время типа DATETIME.
Описание TOUTC: поведение, ограничения и примеры
Запускаемые примеры
TRIM
TRIM возвращает строку после удаления заданных символов с обоих краёв текста.
Синтаксис, аргументы и результат
TRIM(<текст>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
Результат. Функция возвращает строку типа STRING.
TRIM(<текст>, <символы>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
<символы> | Значение аргумента должно быть строкой типа STRING. Передайте строку типа STRING, перечисляющую удаляемые кодовые единицы UTF-16. Это набор отдельных символов, а не подстрока. Если аргумент отсутствует, удаляются пробельные символы, распознаваемые .NET. |
Результат. Функция возвращает строку типа STRING.
Описание TRIM: поведение, ограничения и примеры
Запускаемые примеры
UBOUND
UBOUND возвращает верхнюю границу выбранного измерения массива.
Синтаксис, аргументы и результат
UBOUND(<массив>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
Результат. Функция возвращает целое число типа INTEGER.
UBOUND(<массив>, <измерение>)| Аргумент | Что передать |
|---|---|
<массив> | Передаётся массив элементов типа T; требования к его рангу и состоянию определяются этой функцией. Массив ранга 1 или выше задаёт видимую область обработки. Все элементы имеют тип, установленный при объявлении массива. |
<измерение> | Значение аргумента должно быть целым числом типа INTEGER. Целое число INTEGER выбирает измерение от 1 до ранга включительно. ROW равно 1, COLUMN равно 2. Без этого аргумента выбирается первое измерение, в том числе у многомерного массива. |
Результат. Функция возвращает целое число типа INTEGER.
Описание UBOUND: поведение, ограничения и примеры
Запускаемые примеры
UCASE
UCASE возвращает строку, преобразовав буквы в верхний регистр.
Синтаксис, аргументы и результат
UCASE(<текст>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте исходную строку типа STRING, которую функция должна обработать. |
Результат. Функция возвращает строку типа STRING.
Описание UCASE: поведение, ограничения и примеры
Запускаемые примеры
UTCDATE
UTCDATE возвращает текущую дату по UTC.
Синтаксис, аргументы и результат
UTCDATE()Функция вызывается без аргументов.
Результат. Функция возвращает дату типа DATE.
Описание UTCDATE: поведение, ограничения и примеры
Запускаемые примеры
UTCNOW
UTCNOW возвращает текущую дату и время по UTC.
Синтаксис, аргументы и результат
UTCNOW()Функция вызывается без аргументов.
Результат. Функция возвращает дату и время типа DATETIME.
Описание UTCNOW: поведение, ограничения и примеры
Запускаемые примеры
UTCOFFSET
UTCOFFSET возвращает смещение выбранного часового пояса относительно UTC в минутах для текущего момента или заданных местных часов.
Синтаксис, аргументы и результат
UTCOFFSET()Функция вызывается без аргументов.
Результат. Функция возвращает целое число типа INTEGER.
UTCOFFSET(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть датой и временем типа DATETIME. Передайте дату и время типа DATETIME, дату типа DATE или каноническую строку STRING. Значение задаёт местные часы выбранного часового пояса, для которых определяется смещение относительно UTC. |
Результат. Функция возвращает целое число типа INTEGER.
UTCOFFSET(<значение>, <часовой пояс>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть датой и временем типа DATETIME. Передайте дату и время типа DATETIME, дату типа DATE или каноническую строку STRING. Значение задаёт местные часы выбранного часового пояса, для которых определяется смещение относительно UTC. |
<часовой пояс> | Значение аргумента должно быть строкой типа STRING. Укажите UTC, LOCAL или системный идентификатор пояса, смещение которого требуется получить; без аргумента используется местный пояс. |
Результат. Функция возвращает целое число типа INTEGER.
Описание UTCOFFSET: поведение, ограничения и примеры
Запускаемые примеры
UTCTIME
UTCTIME возвращает текущее время суток по UTC.
Синтаксис, аргументы и результат
UTCTIME()Функция вызывается без аргументов.
Результат. Функция возвращает время суток типа TIME.
Описание UTCTIME: поведение, ограничения и примеры
Запускаемые примеры
VAL
VAL возвращает число, прочитанное из строки.
Синтаксис, аргументы и результат
VAL(<текст>)| Аргумент | Что передать |
|---|---|
<текст> | Значение аргумента должно быть строкой типа STRING. Передайте строку, из которой требуется прочитать числовое значение. |
Результат. Функция возвращает число типа DOUBLE.
Описание VAL: поведение, ограничения и примеры
Запускаемые примеры
WEEKDAY
WEEKDAY возвращает номер дня недели.
Синтаксис, аргументы и результат
WEEKDAY(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть датой типа DATE. Передайте дату, день недели которой требуется определить. |
Результат. Функция возвращает целое число типа INTEGER.
Описание WEEKDAY: поведение, ограничения и примеры
Запускаемые примеры
WEEKDAYNAME
WEEKDAYNAME возвращает английское название дня недели.
Синтаксис, аргументы и результат
WEEKDAYNAME(<день недели>)| Аргумент | Что передать |
|---|---|
<день недели> | Значение аргумента должно быть целым числом типа INTEGER. Укажите номер от 1 для Monday до 7 для Sunday. |
Результат. Функция возвращает строку типа STRING.
Описание WEEKDAYNAME: поведение, ограничения и примеры
Запускаемые примеры
WRITE
WRITE записывает строку в открытый файл без добавления разделителя строки.
Синтаксис, аргументы и результат
WRITE(<файл>, <текст>)| Аргумент | Что передать |
|---|---|
<файл> | Значение аргумента должно быть значением открытого файла типа FILE. имеет тип FILE. Значение типа FILE обозначает ресурс, открытый оператором OPEN в режиме OUTPUT или APPEND. |
<текст> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка текста содержит символы, которые нужно записать. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание WRITE: поведение, ограничения и примеры
Запускаемые примеры
WRITEFILE
WRITEFILE записывает текст в файл, заменяя прежнее содержимое.
Синтаксис, аргументы и результат
WRITEFILE(<путь>, <текст>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к файлу. |
<текст> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка текста содержит символы, которые нужно записать. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
WRITEFILE(<путь>, <текст>, <кодировка>)| Аргумент | Что передать |
|---|---|
<путь> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Аргумент задаёт путь к файлу. |
<текст> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка текста содержит символы, которые нужно записать. |
<кодировка> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка кодировки выбирает UTF-8, WINDOWS-1251, UTF-16LE или UTF-16BE; регистр и крайние пробелы игнорируются. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание WRITEFILE: поведение, ограничения и примеры
Запускаемые примеры
WRITELINE
WRITELINE записывает строку в открытый файл и добавляет символ LF.
Синтаксис, аргументы и результат
WRITELINE(<файл>, <текст>)| Аргумент | Что передать |
|---|---|
<файл> | Значение аргумента должно быть значением открытого файла типа FILE. имеет тип FILE. Значение типа FILE обозначает ресурс, открытый оператором OPEN в режиме OUTPUT или APPEND. |
<текст> | Значение аргумента должно быть строкой типа STRING. имеет тип STRING. Строка текста содержит символы, которые нужно записать. |
Результат. Функция возвращает логическое значение типа BOOLEAN.
Описание WRITELINE: поведение, ограничения и примеры
Запускаемые примеры
YEAR
YEAR возвращает год календарной даты.
Синтаксис, аргументы и результат
YEAR(<значение>)| Аргумент | Что передать |
|---|---|
<значение> | Значение аргумента должно быть датой типа DATE. Передайте дату, год которой требуется извлечь. |
Результат. Функция возвращает целое число типа INTEGER.
Описание YEAR: поведение, ограничения и примеры