Процедуры и функции

COM & OLE
CreateComObjectФункция создает единичный экземпляр объекта COM, не инициализируя его. Используется для создания единичного экземпляра объекта на локальном или "in-process" сервере, когда известен уникальный идентификатор CLSID.
CreateOleObjectФункция создает единичный неинициализированный экземпляр объекта OLE Automation. Объект не должен представлять собой часть агрегированной (aggregation) системы. Функция используется для создания единичного экземпляра объекта на локальном или "in-process" сервере.
GetActiveOleObjectФункция возвращает ссылку на интерфейс IDispatch активного OLE-объекта указанного класса. Функция использует информацию из таблицы активных объектов OLE (OLE running object table).
IDispatchInvokeВызывает метод объекта. Используйте эту функцию для доступа к свойству или методу объекта COM Automation, имя которого совпадает с зарезервированным словом Pascal.
OleCheckПроцедура вызывает исключение, если код в параметре Result указывает на ошибку (Result<0). Используйте OleCheck, чтобы обернуть любые вызываемые вами методы COM на основе IUnknown, чтобы в случае сбоя этого метода возникло исключение.
StringToGUIDВозвращает значение в оригинальном формате CLSID, соответствующее строковому имени уникального идентификатора GUID. В случае неудачи возникает исключение.
DLL
DllGetLastErrorВозвращает код последней ошибки после вызова функции DLL.
UnloadDllВыгружает библиотеку DLL из памяти. Полезно, когда нужно удалить файл библиотеки.
dxForms
GetFormsЗаполняет список формами, отсортированными по алфавиту.
JSON
JSONStringToStringПреобразует JSON-строку в строку. Все экранированные символы в JSON-строке преобразуются в соответствующие символы строки.
ReadJSONFromFileЧитает файл в формате JSON и возвращает новый экземпляр корневого объекта.
ReadJSONFromStreamЧитает JSON-данные из потока и возвращает новый экземпляр корневого объекта.
ReadJSONFromStringЧитает JSON-данные из строки и возвращает новый экземпляр корневого объекта.
StringToJSONStringПреобразует строку в экранированную JSON-строку.
SQL
SQLExecuteВыполняет произвольный SQL-скрипт. Синтаксис DX-SQL не поддерживается.
SQLSelectВыполняет SQL-запрос и возвращает открытый набор данных. Поддерживает синтаксис DX-SQL.
Web
DecodeURLElementВозвращает строку, где шестнадцатиричный код символа %XX преобразуется в реальный символ.
EncodeURLElementВозвращает строку, где каждый недопустимый в URL символ кодируются в последовательность символов %XX, где XX - шестнадцатиричный код символа.
XML
ReadXmlFromFileЧитает XML-данные из файла и возвращает новый экземпляр XML-документа.
ReadXmlFromStreamЧитает XML-данные из потока и возвращает новый экземпляр XML-документа.
ReadXmlFromStringЧитает XML-данные из строки и возвращает новый экземпляр XML-документа.
ReadXmlNodeFromStringЧитает XML-данные из строки и помещает их в родительский узел.
WriteXmlNodeToStringЗаписывает указанный узел Xml-документа в строку.
WriteXmlToFileЗаписывает XML-документ в файл.
WriteXmlToStreamЗаписывает XML-документ в поток.
WriteXmlToStringЗаписывает XML-документ в строку.
Буфер обмена
ClipboardДоступ к системному буферу обмена.
Выражения
EvalExprВычисляет выражение. Если в выражении есть поля, то во втором параметре указывается форма, которой они принадлежат.
ShowExprEditorПоказывает редактор выражений. Если указано имя формы, то в редакторе выражений будет доступна кнопка выбора поля.
Графика
ColorToRGBПреобразует цвет в формат RGB.
ColorToStringПреобразует цвет в строковое представление - название цвета или шестнадцатеричный код.
PointВозвращает координаты XY в виде структурированного типа TPoint.
RectВозвращает сведения о положении и размере в виде структурированного типа TRect.
RedGreenBlueРазбивает цвет в формате RGB на составляющие красного, зеленого и синего цветов.
RGBToColorПреобразует отдельные составляющие цвета в цвет.
StringToColorПреобразует строковое представление цвета в цвет. Строковым представлением цвет может быть название цвета (например, clGreen, clYellow), шестнадцатеричный код (например, $AA0033, $00FF22) или целое число (например, 25500).
Дата и время
AddDayПрибавляет к дате указанное количество дней. Если количество дней отрицательно, то дни будут вычитаться из даты.
AddHourПрибавляет к значению дата/время указанное количество часов. Если количество часов отрицательно, то дата/время будет уменьшено.
AddMinuteПрибавляет к значению дата/время указанное количество минут. Если минуты отрицательные, то дата/время будет уменьшено.
AddMonthПрибавляет к дате указанное количество месяцев. Если количество месяцев отрицательно, то дата будет уменьшена.
AddSecondПрибавляет к значению дата/время указанное количество секунд. Если количество секунд отрицательно, то дата/время будет уменьшено.
AddWeekДобавляет к дате указанное количество недель. Если количество недель отрицательно, то дата будет уменьшена.
AddYearПрибавляет к дате указанное количество лет. Если количество лет отрицательно, то дата будет уменьшена.
BeginMonthВозвращает начало месяца.
BeginQuarterВозвращает начало квартала.
BeginWeekВозвращает начало недели.
BeginYearВозвращает начало года.
CalcPeriodВычисляет стаж или возраст. Результат функции - строка вида: 7 лет 9 месяцев 21 день. Если какое-то значение равно 0, то оно не входит в результат.
DateВозвращает текущую дату.
DateTimeToFileDateПреобразует дату/время в формат операционной системы.
DayOfВозвращает день указанной даты.
DayOfTheWeekВозвращает день недели указанной даты.
DaysBetweenВозвращает количество полных дней между двумя датами. При вычислении дробная часть (время) отбрасывается.
DecodeDateИзвлекает из даты составляющие: год, месяц и день.
DecodeTimeИзвлекает из даты/время составляющие: часы, минуты, секунды, миллисекунды.
EncodeDateСобирает из составляющих дату.
EncodeTimeСобирает из составляющих время.
EndMonthВозвращает конец месяца.
EndQuarterВозвращает конец квартала.
EndWeekВозвращает конец недели.
EndYearВозвращает конец года. Например, если указать дату "12.09.2020", то функция вернет "31.12.2020".
FileDateToDateTimeПреобразует дату и время операционной системы в формат TDateTime.
FmtDateВозвращает текстовое представление даты. Например: 19 мая 2020.
FormatDateTimeПреобразует дату и время в текстовое представление в соответствии с шаблоном.
GetMonthNameВозвращает название месяца.
GetWeekNameВозвращает название дня недели.
HourOfВозвращает количество часов.
HoursBetweenВозвращает количество часов между двумя значениями дата/время.
MilliSecondsBetweenВозвращает количество миллисекунд между двумя значениями дата/время.
MinuteOfВозвращает количество минут.
MinutesBetweenВозвращает количество минут между двумя значениями дата/время.
MonthOfВозвращает номер месяца.
MonthsBetweenВозвращает количество месяцев между двумя значениями дата/время.
NowВозвращает текущие дату и время.
QuarterOfВозвращает номер квартала.
SecondOfВозвращает количество секунд.
SecondsBetweenВозвращает количество секунд между двумя значениями дата/время.
TimeВозвращает текущее время.
TryEncodeDateСобирает дату из составляющих.
TryEncodeTimeСобирает время из составляющих.
WeekOfВозвращает номер недели (года).
WeeksBetweenВозвращает количество недель между двумя значениями дата/время.
YearOfВозвращает номер года.
YearsBetweenВозвращает количество лет между двумя значениями дата/время.
Диалоги
InputBoxОткрывает диалоговое окно для ввода текстового значения.
MessageDlgПоказывает диалоговое окно с сообщением и возвращает код нажатой кнопки.
MsgBoxПоказывает информационное сообщение.
ShowPrintErrorsПоказывает сообщение об ошибках печати. Используется при печати форм из скрипта.
Доступ
GetCurrentRoleВозвращает роль текущего пользователя базы данных.
GetCurrentUserВозвращает имя текущего пользователя базы данных.
Исключения
ExceptionParamВозвращает текст сообщения об ошибке.
ExceptionToStringВозвращает текст сообщения об ошибке, включая ее тип.
ExceptionTypeВозвращает тип ошибки.
RaiseExceptionВызывает исключительную ситуацию.
RaiseLastExceptionВызывает последнюю исключительную ситуацию.
Итоги
DAvgВычисляет среднее значение по указанному полю.
DCountВозвращает количество записей.
DMaxВычисляет максимальное значение указанного поля.
DMergeСоединяет в одну строку значения указанного поля.
DMinВычисляет минимальное значение указанного поля.
DSumВычисляет сумму по указанному полю.
Кодирование
DecodeBase64Декодирует строку BASE64.
EncodeBase64Кодирует строку по алгоритму BASE64.
EncodeMD5Кодирует строку по алгоритму MD5.
EncodeSHA1Кодирует строку по алгоритму SHA1.
HMacMD5Кодирует строку по алгоритму MD5 с применением ключа.
HMacSHA1Кодирует строку по алгоритму SHA1 с применением ключа.
Массивы
GetArrayLengthВозвращает длину массива. То же, что и функция Length.
SetArrayLengthУстанавливает новую длину массива. То же, что и процедура SetLength.
Математика
AbsВозвращает абсолютное значение числа.
CosВычисляет косинус числа.
FracОтбрасывает целую часть и возвращает дробную часть числа.
IntВозвращает целую часть числа.
PiВозвращает значение числа Пи.
PowerВозвращает степень числа.
RandomВозвращает случайное число в пределах от 0 до n.
RoundОкругляет число до целого.
RoundToОкругляет число до указанных знаков.
SameValueПроверяет совпадают ли два вещественных числа.
SinВозвращает синус числа.
SqrtВозвращает квадратный корень числа.
TruncОтбрасывает дробную часть числа и возвращает целую без округления.
Меню
ShortCutВозвращает код клавиши и состояние управляющих клавиш в типе TShortCut.
ShortCutToKeyИзвлекает из типа TShortCut, код клавиши и состояние управляющих клавиш.
Метаданные
GetComponentFieldNameВозвращает имя поля. Если компонент не является полем возвращается пустая строка.
GetComponentIdВозвращает ID компонента: поля, формы или запроса. Если компонент не имеет ID, возвращается 0.
GetPropValueВозвращает значение свойства указанного компонента.
SetPropValueУстанавливает значение свойства компонента.
Отладка
DebugОтображает значение в окне вывода.
DebugFileЗаписывает значение в конец файла. Если файл не существует, он создается автоматически. Процедура автоматически добавляет к значению символы конца строки. Таким образом каждое значение будет в отдельной строке.
Прочее
DecУменьшает число на единицу.
ExcludeУдаляет из множества указанный элемент.
GetBuildDateВозвращает дату сборки DataExpress.
GetFormatSettingsВозвращает глобальные региональные настройки: форматы даты и времени, символы-разделители и пр.
HighВозвращает наибольший индекс массива или порядкового типа.
IncУвеличивает число на единицу.
IncludeВключает во множество указанный элемент.
LowВозвращает наименьший индекс массива или порядкового типа.
OrdВозвращает код символа или порядковый номер (начиная с 0) элемента перечисления.
SetFormatSettingsУстанавливает глобальные региональные настройки: форматы даты и времени, символы-разделители и пр.
SizeOfВозвращает размер переменной.
Работа с типом Variant
NullВозвращает значение Null.
UnassignedВозвращает значение Unassigned.
VarArrayDimCountВозвращает число измерений массива. Возвращает 0, если это не массив.
VarArrayGetВозвращает значение указанного элемента массива.
VarArrayHighBoundВозвращает верхнюю границу массива указанного измерения.
VarArrayLowBoundВозвращает нижнюю границу массива указанного измерения.
VarArrayOfСоздает одномерный массив Variant, содержащий те же значения, что и открытый массив, переданный в качестве аргумента. Результирующий массив имеет нижнюю границу, равную нулю, и верхнюю границу, равную размеру массива минус 1.
VarArraySetУстанавливает значение указанного элемента массива.
VarAsTypeПреобразует значение типа вариант в другой тип вариант. Если это невозможно, то возникает исключение.
VarCastПриведение типа вариант к другому типу. Если приведение невозможно, возникает исключение.
VarIsEmptyВозвращает True, если значение пусто (имеет тип varEmpty).
VarIsNothingВозвращает True, если переменная IDispatch равна nil.
VarIsNullВозвращает True, если значение равно Null.
VarToStrПреобразует тип вариант в строку.
VarTypeВозвращает тип переменной вариант.
Строки
AnsiLowerCaseПреобразует символы строки к нижнему регистру.
AnsiUpperCaseПреобразует символы строки к верхнему регистру.
ChrВозвращает символ с указанным кодом.
CopyКопирует часть строки, начиная с iFrom символа и длиной iCount символов. Если iCount больше длины строки S, результат обрезается. Если iFrom больше длины строки S, возвращается пустая строка. Индекс начинается с 1.
DateToStrПреобразует дату в строку. Формат даты будет зависеть от глобальный настроек форматирования.
DeleteУдаляет из строки iCount символов, начиная с позиции iFrom. Нумерация символов начинается с 1.
FillZerosВозвращает строковое представление числа с ведущими нулями. Если в числе меньше цифр, чем N, остальное заполняется нулями.
FloatToStrПреобразует число в строку. Результат зависит от глобальных настроек форматирования.
FormatФорматирует строку в соответствии с шаблоном. Шаблон представляет собой текст с заполнителями, вместо которых подставляются элементы массива Args.
FormatFloatФорматирует число по шаблону. Шаблон представляет собой текст, сочетающийся с управляющими символами.
InsertВставляет строку InsertStr в строку TargetStr в указанную позицию. Позиция начинается с 1.
Int64ToStrПреобразует целое число в строку.
IntToHexПреобразует число в шестнадцатеричное представление длиной не менее Digits. Если фактическая длина результата больше требуемой длины, то строка НЕ обрезается. Если меньше, то дополняется нулями.
IntToStrПреобразует целое число в строку.
LengthВозвращает длину строку или массива.
LowerCaseВозвращает строку в нижнем регистре. Обрабатываются только символы с кодом меньше 127.
PadLДополняет строку пробелами слева до требуемой длины I.
PadRДополняет строку пробелами справа до требуемой длины I.
PadZДополняет строку нулями слева до требуемой длины I.
PosВозвращает позицию первого вхождения подстроки в строку. Возвращает 0, если подстрока не найдена.
ReplicateДублирует символ I раз и возвращает в виде строки.
SetLengthУстанавливает новую длину строки или массива. При изменении длины строки или массива данные сохраняются.
SplitStrРазбивает строку на подстроки, определяемые разделителем, и добавляет подстроки в существующий экземпляр списка строк. Перед вызовом процедуры объект SL должен быть создан. Перед добавлением подстрок процедура очищает список.
StrGetВозвращает символ строки с индексом I. Индекс начинается с 1.
StringOfCharДублирует символ I раз и возвращает в виде строки.
StringReplaceВозвращает строку, в которой подстрока, соответствующая OldPattern, заменена на подстроку NewPattern.
StrSetЗаписывает в строку символ в индекс I. Индекс начинается с 1.
StrToDateПреобразует текст в дату. Формат даты и разделители должны соответствовать глобальным настройкам форматирования. Если формат даты некорректный, срабатывает исключение.
StrToDateTimeПреобразует текст в дату и время. Формат даты, времени и разделители должны соответствовать глобальным настройкам форматирования. Если формат некорректный, срабатывает исключение.
StrToFloatПреобразует строку в число. Формат числа и разделители должны соответствовать глобальным настройкам форматирования. Если формат некорректный, срабатывает исключение.
StrToIntПреобразует текст в целое число. Формат числа должны соответствовать глобальным настройкам форматирования. Если формат некорректный, срабатывает исключение.
StrToInt64Преобразует текст в целое число. Формат числа должны соответствовать глобальным настройкам форматирования. Если формат некорректный, срабатывает исключение.
StrToInt64DefПреобразует текст в целое число. Формат числа должны соответствовать глобальным настройкам форматирования. Если преобразование не удалось, возвращается значение по умолчанию def.
StrToIntDefПреобразует текст в целое число. Формат числа должны соответствовать глобальным настройкам форматирования. Если преобразование не удалось, возвращается значение по умолчанию def.
StrToTimeПреобразует текст во время. Формат времени и разделители должны соответствовать глобальным настройкам форматирования. Если формат некорректный, срабатывает исключение.
TimeToStrПреобразует время в строку. На результат влияют глобальные настройки форматирования.
TrimВозвращает строку с удаленными начальными и конечными пробелами.
TryStrToDateПробует преобразовать строку в дату. Формат даты и разделители должны соответствовать глобальным настройкам форматирования.
TryStrToDateTimeПробует преобразовать строку в дату и время. Формат даты, времени и разделители должны соответствовать глобальным настройкам форматирования.
TryStrToFloatПробует преобразовать строку в число. Формат числа и разделители должны соответствовать глобальным настройкам форматирования.
TryStrToIntПробует преобразовать строку в целое число. Формат числа разделители должны соответствовать глобальным настройкам форматирования.
TryStrToInt64Пробует преобразовать строку в целое число. Формат числа разделители должны соответствовать глобальным настройкам форматирования.
TryStrToTimeПробует преобразовать строку во время. Формат времени разделители должны соответствовать глобальным настройкам форматирования.
UpperCaseПреобразует символы строки к верхнему регистру. Обрабатываются только символы с кодом меньше 127.
WStrGetВозвращает символ строки под индексом I. Индекс начинается с 1.
WStrSetЗаписывает символ строки в индекс I. Индекс начинается с 1.
Строки UTF-8
RurToWordsВозвращает число прописью на русском языке с указанием рублей и копеек.
StringToUtf8CharПреобразует строку в символ UTF-8.
ToWordsRuВозвращает число прописью на русском языке.
UTF16ToUTF8Преобразует строку UTF-16 в строку UTF-8.
Utf8CharToStringПреобразует символ UTF-8 в строку.
UTF8CompareStrСравнивает две строки UTF-8 с учетом регистра.
UTF8CompareTextСравнивает две строки UTF-8 без учета регистра.
UTF8CopyВозвращает копию строки, начиная с позиции StartCharIndex и длиной CharCount. Позиция начинается с 1. Если указанная длина больше длины строки, то строка копируется до последнего символа.
UTF8DeleteУдаляет из строки CharCount символов, начиная с позиции StartCharIndex. Позиция начинается с 1.
UTF8InsertВставляет строку InsertStr в строку-приемник TargetStr в позицию StartCharIndex. Позиция начинается с 1. Если позиция меньше или равна 1, текст вставляется в начало. Если позиция больше длины строки-приемника, то текст вставляется в конец.
UTF8LengthВозвращает длину строки UTF-8.
UTF8LowerCaseПреобразует символы строки к нижнему регистру.
UTF8PosВозвращает позицию первого вхождения подстроки SearchForText в строку SearchInText, Возвращает 0, если подстрока не найдена.
UTF8StringReplaceЗаменяет подстроку OldPattern в исходной строке S на подстроку NewPattern.
UTF8ToUTF16Преобразует строку UTF-8 в строку UTF-16.
Utf8ToWinCPПреобразует строку UTF-8 в кодировку кодовой страницы Windows.
UTF8UpperCaseПреобразует символы строки к верхнему регистру.
WinCPToUtf8Преобразует строку в кодировке Windows в строку UTF-8.
Файловая система
ChangeFileExtМеняет расширение файла на новое. Перед расширением должна указываться точка.
CopyFileКопирует файл SrcFilename в файл DestFileName.
CreateDirСоздает каталог. Если каталог не содержит абсолютного пути, тогда каталог создается ниже текущего рабочего каталога.
DeleteFileУдаляет файл. Если задан относительный путь, то файл ищется относительно текущего каталога.
DirectoryExistsВозвращает True, если каталог существует. Если задан относительный путь, то каталог проверяется относительно текущего каталога.
ExcludeLeadingPathDelimiterУдаляет из пути ведущий слеш.
ExpandFileNameПреобразует относительный путь к файлу в абсолютный.
ExtractFileDirИзвлекает из имени файла путь к каталогу без конечного разделителя каталогов.
ExtractFileDriveИзвлекает из имени файла букву диска.
ExtractFileExtИзвлекает из имени файла расширение вместе с точкой. Возвращается пустая строка, если имя файла не имеет расширения.
ExtractFileNameИзвлекает имя файла вместе с расширением из полного имени файла.
ExtractFileNameOnlyИзвлекает только имя файла без расширения из полного имени файла.
ExtractFilePathИзвлекает из имени файла путь к каталогу, включая конечный разделитель каталогов.
FileAgeВозвращает время последнего изменения файла в формате ОС. Если путь относительный, то файл определяется относительно текущего каталога.
FileExistsВозвращает True, если файл существует. Путь к файлу может быть относительным. В Unix-системах в функцию можно передавать каталог.
FileGetAttrВозвращает атрибуты файла.
FileSetAttrУстанавливает атрибуты файла.
FileSetDateУстанавливает дату изменения файла.
FileSizeВозвращает размер файла в байтах.
FindAllDirectoriesИщет каталоги по указанному пути.
FindAllFilesИщет файлы в соответствии с заданной маской.
ForceDirectoriesСоздает каталог по указанному пути. Если по заданному пути каталоги не найдены, они создаются автоматически.
GetCurrentDatabaseВозвращает путь к текущей базе данных. Результат может быть абсолютный путь к файлу или сетевой путь в формате СУБД Firebird.
GetCurrentDirВозвращает текущий рабочий каталог.
GetOutputDirВозвращает путь к папке вывода.
GetTempDirВозвращает путь к каталогу временных файлов.
GetTempFileNameВозвращает имя временного файла в папке временных файлов.
GetTemplatesDirВозвращает путь к каталогу шаблонов.
IncludeTrailingPathDelimiterДобавляет в конец пути слеш, если его там нет.
RemoveDirУдаляет пустой каталог.
RenameFileПереименовывает/перемещает файл.
ShellExecuteЗапускает внешнее приложение или открывает файл в связанном приложении.