CommuniGate Pro: Язык Программирования CommuniGate Pro (CG/PL)

Следующие процедуры и функции являются встроенными в язык и они доступны для всех приложений: Вы не должны использовать их имена для собственных определений процедур или функций.

Same(arg1,arg2): Эта функция возвращает значение истина, если значения аргументов arg1 и arg2 являются одним и тем же объектом или если оба они имеют нулевые значения, или если оба значения являются истинными. В других случаях функция возвращает нулевое значение.
Значение функции Same("J" + "ack","Jack") является нулевым.
В следующем примере:
x = "my string";
y = "my string";
z = x;
test1 = Same(x,y);
test2 = Same(x,x);
test3 = Same(x,z);
результатом test1 является нулевое значение, а результатами test2 и test3 является значение истина.
Copy(arg): Если значение arg является нулевым, то эта функция возвращает нулевое значение.
В противном случае, функция возвращает копию значения arg.
Для сложных объектов (таких как массивы, словари, XML объекты), эта функция копирует также все элементы сложных объектов.
Length(arg): Если arg является строкой, то это функция возвращает размер строки (в байтах);
Если arg является блоком данных, то это функция возвращает размер блока данных (в байтах);
Если arg является массивом, то это функция возвращает число элементов массива;
Если arg является словарём, то это функция возвращает число ключей словаря;
Если arg является описателем папки, то это функция возвращает число сообщений в папке;
Во всех других случаях эта функция возвращает число 0.
Min(arg1,arg2): Если значение arg1 < значения arg2, то функция возвращает значение arg1, иначе она возвращает значение arg2.
Смотрите выше определение операции <.
Max(arg1,arg2): Если значение arg1 > значения arg2, то функция возвращает значение arg1, иначе она возвращает значение arg2.
Смотрите выше определение операции >.
Void(arg1): Эта процедура не делает ничего, значение arg1 выбрасывается. Используйте эту процедуру, если вам необходимо вызвать функцию, но вам не нужен результат этой функции.

Строки

IsString(arg): Эта функция возвращает истину, если arg является строкой; в противном случае функция возвращает нулевое значение.
String(arg): Если значением arg является строка, то эта функция возвращает эту строку.
Если значением arg является число, то эта функция возвращает десятичное представление этого числа.
Если значением arg является блок данных, то эта функция возвращает строку, в которой содержится этот блок данных (интерпретируемый как текстовые данные).
Если значением arg является отметка о времени, то эта функция возвращает её текстовое представление в стандартном для этой системы виде.
Если значением arg является IP адрес, то эта функция возвращает каноническое представление этого сетевого адреса.
Если значением arg является XML Объект, то эта функция возвращает текстовое тело XML Объекта ("текстовый узел").
Если значение arg является нулевым, то эта функция возвращает нулевое значение.
Во всех других случаях эта функция возвращает строку с текстовым представлением значения arg.
FindSubstring(str,substr): Если значениями str и substr являются строки и последняя является подстрокой в строке str, то эта функция возвращает позицию подстроки substr в строке str (позиция начинается с 0).
Например, значением FindSubstring("forest","for") является 0.
Во всех других случаях эта функция возвращает число -1.
Substring(str,from,len): Если значением str является строка, значением from является число, а значение len является неотрицательным числом, то эта функция возвращает строку, являющуюся подстрокой строки str и имеющую длину len.
Если from имеет неотрицательное значение, то подстрока начинается с позиции from (первый символ строки имеет позицию 0).
Если from имеет отрицательное значение, то подстрока заканчивается в позиции -1-from, считая от конца строки (для того, что бы включить в подстроку только последний символ, from должно быть -1).
Если значение from (или значение -1-from) равно или больше длине строки str, то результатом является пустая строка.
Если значение from + len (или -1-from + len) больше, чем длина строки str, то результирующая строка будет короче, чем len.
Во всех других случаях эта функция возвращает нулевое значение.
Обратите внимание: эта функция интерпретирует сроку как последовательность байт, и, как следствие, она может исказить не-ASCII символы, хранящиеся в виде многобайтовой последовательности.
Range(str,from,len): Эта функция работает так же, как как и функция Substring, но если значение str является строкой, то она интерпретируется как последовательность "глифов" - одно- и многобайтовых последовательностей, представляющих ASCII и не-ASCII символы. Значения from и len задают позицию подстроки и её длину в терминах символов, а не байт.
Если str является блоком данных, то функция возвращает блок данных, содержащий часть значений str и вырезанный с использованием вышеописанных правил, где from и len задают позицию и длину в байтах.
EOL(): Эта функция возвращает строку, содержащую символ(ы) EOL (конца строки), используемые в ОС Сервера.
CRLF(): Эта функция возвращает строку с символами EOL, принятым в Интернет (<возврат каретки><перевод строки>).
ToUpperCase(str): Если значением str является строка, то результатом функции будет строка, все буквы в которой преобразованы к верхнему регистру.
ToLowerCase(str): Если значением str является строка, то результатом функции будет строка, все буквы в которой преобразованы к нижнему регистру.
IsDigit(str): Эта функция возвращает значение истина, если str является односимвольной строкой и этот символ является десятичной цифрой (0..9); в противном случае функция возвращает нулевое значение.
FindRegEx(str,picture): Эта функция сравнивает строку str со картинкой строки, содержащей регулярные выражения.
Если str или picture не являются строками, или строка picture не может быть интерпретирована как регулярное выражение, или строка str не соответствует регулярному выражению, то функция возвращает нулевое значение.
В противном случае функция возвращает массив строк. Нулевое элемент этого массива содержит копию строки str, а остальные дополнительные элементы (если они есть) содержат подстроки строки str, соответствующие группам регулярных выражений.
В строке picture должно находится используемое регулярное выражение, заданное в соответствии с расширенным синтаксисом POSIX.
EmailDomainPart(address): Если значение address является строкой и строка содержит символ @, то эта функция возвращает строку, содержащую часть строки address после первого символа @.
В противном случае функция возвращает нулевое значение.
EmailUserPart(address): Если значение address не является строкой, то эта функция возвращает нулевое значение.
Если значение address не содержит символ @, то эта функция возвращает ту же самую строку.
В противном случае (значение address является строкой, содержащей символ @), эта функция возвращает строку, содержащую часть строки address перед первым символом @.

Числа

IsNumber(arg): Эта функция возвращает значение истина, если arg является числом; в противном случае функция возвращает нулевое значение.
Number(arg): Если значением arg является число, то эта функция возвращает это же число.
Если значением arg является строка, то эта функция возвращает числовое значение этой строки до первого не-цифрового символа.
Например, значением Number("123#") является 123.
Во всех других случаях эта функция возвращает число 0.
RandomNumber(): Эта функция возвращает случайное целое число в диапазоне [0..9223372036854775807] ([0..2*63-1]).

Отметки о Времени

IsDate(arg): Эта функция возвращает истину, если arg является отметкой о времени; в противном случае функция возвращает нулевое значение.
Date(arg): Если значением arg является отметка о времени, то эта функция возвращает эту отметку о времени.
Если значением arg является число 0, то эта функция возвращает отметку о времени из "далёкого прошлого".
Если значением arg является отрицательное число, то эта функция возвращает отметку о времени из "далёкого будущего".
Если значением arg является положительное число N, то эта функция возвращает отметку о времени, соответствующую началу N-ного дня, считая со 2-го января 1970-го.
Если значением arg является строка, являющаяся текстовым представлением отметки о времени,то эта функция возвращает эту отметку о времени.
Во всех других случаях эта функция возвращает нулевое значение.
GMTTime(): Эта функция возвращает объект - отметку о времени, имеющую значение текущего GMT времени.
LocalTime(): Эта функция возвращает объект - отметку о времени, имеющую значение текущего локального времени.
GMTToLocal(arg): Если значение arg является отметкой о времени, то эта функция возвращает отметку о времени, содержащее значение arg, конвертированное из GMT в локальное время.
Во всех других случаях эта функция возвращает нулевое значение.
LocalToGMT(arg): Если значение arg является отметкой о времени, то эта функция возвращает отметку о времени, содержащее значение arg, конвертированное из локального времени в GMT время.
Во всех других случаях эта функция возвращает нулевое значение.
Year(arg): Если значение arg является отметкой о времени, то эта функция возвращает число, содержащее год из значения arg.
Если отметка о времени имеет значение "далёкое прошлое", то эта функция возвращает число 0.
Если отметка о времени имеет значение "далёкое будущее", то эта функция возвращает число 9999.
Во всех других случаях эта функция возвращает нулевое значение.
Month(arg): Если значение arg является отметкой о времени, то эта функция возвращает строку, содержащую имя месяца из значения arg (Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec).
Если значение arg является числом в диапазон 1..12, то эта функция возвращает строку, содержащее имя месяца номер arg (arg (Month(1) возвращает Jan).
Во всех других случаях эта функция возвращает нулевое значение.
MonthNum(arg): Если значение arg является отметкой о времени, то эта функция возвращает число, содержащее номер месяца из значения arg (1 для Января).
Во всех других случаях эта функция возвращает нулевое значение.
MonthDay(arg): Если значение arg является отметкой о времени, то эта функция возвращает число, содержащее день месяца из значения arg (1 возвращается для первого дня месяца).
Во всех других случаях эта функция возвращает нулевое значение.
WeekDay(arg): Если значение arg является отметкой о времени, то эта функция возвращает день недели из значения arg (Mon, Tue, Wed, Thu, Fri, Sat, Sun).
Во всех других случаях эта функция возвращает нулевое значение.
YearDay(arg): Если значение arg является отметкой о времени, то эта функция возвращает число, содержащее день года из значения arg (число 1 возвращается для первого января).
Во всех других случаях эта функция возвращает нулевое значение.
TimeOfDay(arg): Если значение arg является отметкой о времени, то эта функция возвращает число секунд между датой из значения arg и началом этой даты.
Во всех других случаях эта функция возвращает нулевое значение.
DateNumber(arg): Если значение arg является отметкой о времени, то эта функция возвращает число полных дней между датой из значения arg и первым января 1970.
Во всех других случаях эта функция возвращает нулевое значение.
DateByMonthDay(year,monthNum,monthDay): Значения year, monthNum, monthDay должны быть положительными числами. Если любой из этих объектов задан некорректно, то эта функция возвращает нулевое значение. В противном случае функция возвращает объект с отметкой о времени, представляющий указанную дату.
Следующее выражение имеет своим значением отметку о времени полночь, 5 ноября 2008 года:
DateByMonthDay(2008,11,5)
DateByYearDay(year,yearDay): Значения year, yearDay должны быть положительными числами. Если любой из этих объектов задан некорректно, то эта функция возвращает нулевое значение. В противном случае функция возвращает объект с отметкой о времени, представляющий указанную дату.
Следующее выражение имеет своим значением отметку о времени полночь, 1 февраля 2006 года:
DateByYearDay(2006,32)

IP Адреса

IsIPAddress(arg): Эта функция возвращает истину, если значение arg является IP адресом; в противном случае функция возвращает нулевое значение.
IPAddress(arg): Если значением arg является IP адрес, то эта функция возвращает этот IP адрес.
Если значением arg является строка с корректным представлением IP адреса (опционально - с номером порта), то эта функция возвращает этот IP адрес.
Во всех других случаях эта функция возвращает нулевое значение.

Блоки Данных

IsData(arg): Эта функция возвращает истину, если arg является блоком данных; в противном случае функция возвращает нулевое значение.
RandomData(length): Значение length должно быть положительным числом, не превышающим 4096.
Эта функция возвращает блок данных указанной длины, заполненный случайными данными.

Массивы

IsArray(arg): Эта функция возвращает истину, если arg является массивом; в противном случае функция возвращает нулевое значение.
NewArray(): Эта функция возвращает новый созданный пустой массив.
Invert(arg): Значение arg должно быть массивом, иначе вызов этой функции приведёт к возникновению исключительной ситуации.
Эта функция возвращает массив, содержащий те же самые элементы, что и arg, но в обратном порядке.
Find(source,object): Если значением source является массив, то эта функция возвращает число - индекс первого элемента в массиве, равного значению object. Если в массиве source не содержится такого объекта, то возвращается отрицательное числовое значение.
Если значение source не является массивом, то возвращается отрицательное числовое значение.
AddElement(target,element): Если значение target является массивом, то эта процедура добавляет значение element как новый последний элемент этого массива.
Если значение target является XML Объектом, то процедура добавляет значение element как новый подэлемент (значение element должно быть строкой или XML Объектом).
Во всех других случаях вызов этой процедуры приведёт к возникновению исключительной ситуации.
Если значением myArray является (1,4,9,16,25), то вызов AddElement(myArray,"test") изменит значение myArray на (1,4,9,16,25,"test").
RemoveElement(target,index): Эта процедура удаляет элемент из массива.
Значение target должно быть массивом, иначе вызов этой процедуры приведёт к возникновению исключительной ситуации.
Значением index должно быть число или строка, содержащая десятичное число, задающее элемент массива, который подлежит удалению. В других случаях удаляется первый (с индексом ноль) элемент массива.
Если значением myArray является (1,4,9,16,25), то вызов RemoveElement(myArray,2) изменит значение myArray на (1,4,16,25).
InsertElement(target,index,element): Эта процедура вставляет элемент в массив.
Значение target должно быть массивом, иначе вызов этой процедуры приведёт к возникновению исключительной ситуации.
Значением index должно быть число или строка, содержащая десятичное число, задающее место, куда должен быть вставлен элемент массива. Для всех существующих элементов массива с индексом index и выше значение их индекса увеличится на 1.
Если значением myArray является (1,4,9,16,25), то вызов InsertElement(myArray,2,"Jack") изменит значение myArray на (1,4,"Jack",9,16,25).
SortStrings(arg): Эта процедура сортирует элеметны массива.
Значение target должно быть массивом и все элементы этого массива должны быть строками, иначе вызов этой процедуры приведёт к возникновению исключительной ситуации.
Элеметны массива сравниваются как независимые от регистра строки UTF-8.

Словари

IsDictionary(arg): Эта функция возвращает истину, если arg является словарём; в противном случае функция возвращает нулевое значение.
NewDictionary(): Эта функция возвращает новый созданный пустой словарь.
SetCaseSensitive(target,flag): Эта процедура указывает, должны ли ключи словаря обрабатываться как зависимые от регистра.
Значение target должно быть словарём, иначе вызов этой процедуры приведёт к возникновению исключительной ситуации.
Если flag имеет ненулевое значение, то словарь target будет независимым от регистра, иначе он будет зависимым от регистра.
Новые словари создаются как зависимые от регистра.

XML Объекты

IsXML(arg): Эта функция возвращает значение истина, если значение arg является XML Объектом, иначе функция возвращает нулевое значение.
NewXML(type,prefix): Эта функция возвращает вновь созданный XML Объект типа type. Значение type должно быть строкой, в которой содержится корректный XML тег.
Значение prefix может быть нулевым значением илм строкой, содержащей корректный XML префикс. Этот префикс используется для определения имени XML объекта.
SetNamespace(data,namespace,prefix): Эта процедура связывает XML префикс с некоторым пространством имён.
Значение data должно быть XML Объектом, иначе вызов этой процедуры приведёт к возникновению исключительной ситуации.
Значение prefix должно быть строкой, содержащей корректный XML префикс.
Если namespace имеет нулевое значение, то пространство имён, связываемое с prefix, удаляется. В противном случае namespace должно быть строкой, содержащей пространство имён, связываемое со значением prefix.
GetNamespace(data,prefix): Эта функция возвращает строку с пространством имён, связанным с указанным XML префиксом или нулевое значение, если связанное пространство имён не существует.
Значение data должно быть XML Объектом, иначе вызов этой функции приведёт к возникновению исключительной ситуации.
Значение prefix должно быть строкой, содержащей корректный XML префикс.
SetAttribute(data,attribute,name,prefix): Эта процедура устанавливает атрибут XML Объекта для указанного имени и префикса.
Значение data должно быть XML Объектом, иначе вызов этой процедуры приведёт к возникновению исключительной ситуации.
Значение name должно быть строкой, содержащей корректное имя XML атрибута.
Значение prefix должно быть либо нулевым, либо строкой, содержащей корректный XML префикс.
Если значение attribute является нулевым, то атрибут с указанным именем и префиксом удаляется. В противном случае значение attribute должно быть строкой, содержащей новое значение атрибута.
GetAttribute(data,name,prefix): Эта функция возвращает строку со значением атрибута с заданным именем и префиксом, или нулевое значение, если такого атрибута не существует.
Значение data должно быть XML Объектом, иначе вызов этой функции приведёт к возникновению исключительной ситуации.
Значение name должно быть строкой, содержащей корректное имя XML атрибута.
Значение prefix должно быть либо нулевым, либо строкой, содержащей корректный XML префикс.
XMLBody(data,type,namespace,index): Эта функция возвращает XML подэлемент с указанным типом, пространством имён и позицией, либо нулевое значение, если такого подэлемента не существует.
Значение data должно быть XML Объектом, иначе вызов этой функции приведёт к возникновению исключительной ситуации.
Значение type должно быть нулевым или строкой, в которой содержится корректное имя XML атрибута. Если значение type является нулевым, то эта функция возвращает подэлементы любого типа.
Значение namespace должно быть либо нулевым, либо строкой, содержащей пространство имён. Если namespace имеет нулевое значение, то функций ищет подэлементы, игнорируя их пространства имён.
Значение index должно быть неотрицательным числом. Для получения первого подэлемента заданного типа и пространства имён, значение index должно быть 0.
XMLType(data): Эта функция возвращает строку с типом XML Объекта.
Значение data должно быть XML Объектом, иначе вызов этой функции приведёт к возникновению исключительной ситуации.
XMLPrefix(data): Эта функция возвращает строку с префиксом типа XML Объекта.
Значение data должно быть XML Объектом, иначе вызов этой функции приведёт к возникновению исключительной ситуации.

Преобразование Данных

ObjectToString(arg): Эта функция возвращает строку с текстовым представлением значения arg.
Если значение arg является нулевым, то эта функция возвращает строку #null#.
ObjectToXML(arg)

Среда

Vars(): Эта функция возвращает словарь, уникальный для этой Задачи (для этого вызова программы). Этот словарь может использоваться для хранения переменных, видимых во всех процедурах и функциях, выполняемых в рамках этой Задачи.
Когда Задача запускается с параметрами (например, когда Приложение Реального Времени запускается для обработки Сигнала, перенаправленного Маршрутизатором), то массив с параметрами помещается в элемент startParameter словаря Vars().
В следующем примере запрашиваются два первых параметра Задачи:
firstParam = Vars().startParameter[0];
secondParam = Vars().startParameter[1];

Адреса и URI

SIPURIToEmail(uri): Эта функция преобразовывает значение uri из SIP URI в строку с адресом электронной почты.
Если значение uri не является строкой или оно не может быть разобрано как SIP URI, то функция возвращает нулевое значение.
EmailToSIPURI(email): Эта функция преобразовывает значение email с адресом электронной почты в строку SIP URI.
Если значение email не является строкой или оно не может быть разобрано как адрес электронной почты, то функция возвращает нулевое значение.
PhoneNumberToSIPURI(phoneNumber): Эта функция преобразовывает значение phoneNumber в строку SIP URI.
Если значение phoneNumber не является строкой или оно не может быть разобрано как телефонный номер, то функция возвращает нулевое значение.
Функция удаляет все форматирующие символы из значения phoneNumber, оставляя только цифры и (если он существует) лидирующий символ плюс (+).
Функция добавляет имя текущего Домена в преобразованный номер.
RouteAddress(email,type)

Данные Пользователя

Следующие функции и процедуры доступны, если у программы (Задачи) существует набор "текущего Пользователя".

MyDomain(): Эта функция возвращает строку с именем текущего Домена, если он есть. Если для текущей Задачи отсутствует связанный с ней конкретный Пользователь или Домен, то функция возвращает нулевое значение.
MyEmail(): Эта функция возвращает строку с адресом электронной почты текущего Пользователя, если он есть. Если для текущей Задачи отсутствует связанный с ней конкретный Пользователь, то функция возвращает нулевое значение.
GetAccountPreferences(keyName): Эта функция возвращает Настройки текущего Пользователя.
Если keyName является непустой строкой, то возвращается объект Настроек Пользователя, связанный с этим ключом. Иначе возвращается словарь со всеми фактически действующими Настройками Пользователя.
Если строка keyName начинается с префикса ~username/, то префикс удаляется. Строка username задаёт имя Пользователя, которого необходимо использовать. Если этот Пользователь не является текущим Пользователем, то операция заканчивается успешно только в случае, если текущий Пользователь имеет для указанного Домена Пользователя право доступа Администратора Домена.
SetAccountPreferences(keyValue,keyName): Эта функция изменяет Настройки текущего Пользователя.
Если keyName является непустой строкой, то значение keyValue задаёт новый объект для этого ключа. Если keyValue имеет нулевое значение, то объект удаляется из Настроек Пользователя, и для указанного ключа начинает действовать значение по умолчанию.
Если строка keyName начинается с префикса ~username/, то префикс удаляется. Строка username задаёт имя Пользователя, настройки которого необходимо изменить. Если этот Пользователь не является текущим Пользователем, то операция заканчивается успешно только в случае, если текущий Пользователь имеет для указанного Домена Пользователя право доступа Администратора Домена.
Если keyName является строкой вида ~username/ или пустой строкой, либо не является строкой, то значение keyValue должно быть словарём. Он используется для изменения Настроек Пользователя.
Эта функция возвращает нулевое значение, если данные Настроек Пользователя были успешно изменены; в противном случае возвращается строка с кодом ошибки.

Impersonate(email)

Папки

ListMailboxes(filter)

Эта функция возвращает все Папки текущего Пользователя.
Значение filter должно быть строкой - она определяет шаблон для поиска. Если она имеет нулевое значение, то используется шаблон для поиска * (все Папки Пользователя).
Для поиска Папок другого Пользователя, шаблон поиска должен быть задан как ~accountname/pattern.
Если операция закончилась успешно, то эта функция возвращает словарь. Каждый ключ словаря является строкой с найденным именем Папки.
Значением этого элемента является:

словарь с атрибутами Папки - если найденная папка является только "хранилищем элементов".
пустым массивом - если найденная Папка является только "папкой".
массивом с одним элементом словаря - если найденная Папка является как просто "папкой", так и "хранилищем элементов".

Если права Доступа к Папке позволяют текущему Пользователю видеть эту Папку, но не позволяют текущему Пользователю открывать её, то словарь с Атрибутами Папки заменяется строкой, содержащей Права Доступа к Папке для текущего Пользователя.
Если эта функция заканчивает свою работу неуспешно, то она возвращает строку с кодом ошибки.

CreateMailbox(mailboxName,class)

Эта функция создаёт Папку mailboxName у текущего Пользователя.
Если class имеет ненулевое значение, то он задаёт Класс Папки для вновь создаваемой Папки.
Эта функция возвращает нулевое значение, если Папка была успешно создана; в противном случае возвращается строка с кодом ошибки.

RenameMailbox(oldMailboxName,newMailboxName,renameSub)

Эта функция переименовывает папку oldMailboxName текущего Пользователя в папку newMailboxName. Оба параметра должны иметь строковые значения.
Если значение renameSub является ненулевым, то также переименовывается и Подпапки oldMailboxName.
Эта функция возвращает нулевое значение, если Папка была успешно переименована; в противном случае возвращается строка с кодом ошибки.

DeleteMailbox(mailboxName,deleteSub)

Эта функция удаляет Папку mailboxName текущего Пользователя.
Если значение deleteSub является ненулевым, то также удаляются Подпапки mailboxName.
Эта функция возвращает нулевое значение, если Папка была успешно удалена; в противном случае возвращается строка с кодом ошибки.

GetMailboxACLs(mailboxName)

Эта операция читает Список Прав Права Доступа к Папки mailboxName.
Если функция успешно прочитала данные ACL, то она возвращает словарь, в котором идентификаторы ACL являются ключами, а значением являются строки с соответствующими правами доступа.
В противном случае функция возвращает строку с кодом ошибки.

SetMailboxACLs(mailboxName,newACLs)

Эта операция изменяет Список Прав Права Доступа для Папки mailboxName.
Значение newACL должно быть словарём, в котором идентификаторы ACL являются ключами, а значением являются строки с соответствующими правами доступа.
Для удаление идентификатора ACL из словаря, задайте его значение как пустой массив.
Эта функция возвращает нулевое значение, если ACL Папки был успешно изменён; в противном случае возвращается строка с кодом ошибки.

Обратите внимание: Для доступа к папкам других пользователей указывайте имя Папки как

~account[@domainName]/mailboxName

GetMailboxAliases(accountName): Эта функция читает Псевдонимы Папки, созданные у Пользователя accountName или, если accountName имеет нулевое значение, у текущего Пользователя.
Если функция успешно читает данные о Псевдонимах Папки, то она возвращает словарь. Каждый ключ словаря является именем Псевдонима Папки; значением ключа является строка с именем папки, на которую указывает этот Псевдоним.
В противном случае функция возвращает строку с кодом ошибки.
SetMailboxAliases(newAliases,accountName): Эта функция задаёт Псевдонимы Папки, созданные для Пользователя accountName или, если accountName имеет нулевое значение, для текущего Пользователя. Старые Псевдонимы Папки удаляются.
Значение newAliases должно быть словарём. Каждый ключ словаря является именем Псевдонима Папки; значением ключа является строка с именем папки, на которую указывает этот Псевдоним.
Эта функция возвращает нулевое значение, если Псевдонимы Папки были успешно изменены; в противном случае возвращается строка с кодом ошибки.
GetMailboxSubscription(accountName): Эта функция читает подписки на Папки, созданные у Пользователя accountName или, если accountName имеет нулевое значение, у текущего Пользователя.
Если функция успешно читает данные подписки на Папки, то она возвращает массив. Каждый элемент массива должен быть строкой, в которой содержится имя Папки.
В противном случае функция возвращает строку с кодом ошибки.
SetMailboxSubscription(newSubscription,accountName): Эта функция задаёт подписки на Папки, созданные для Пользователя accountName или, если accountName имеет нулевое значение, для текущего Пользователя. Старые элементы подписки на Папки удаляются.
Значение newSubscription должно быть массивом. Каждый элемент массива должен быть строкой, в которой содержится имя Папки.
Эта функция возвращает нулевое значение, если подписки на Папки были успешно изменены; в противном случае возвращается строка с кодом ошибки.

Описатели Папок

Описатели Папок являются внутренними объектами, представляющими Папки.

OpenMailbox(mailboxName)

Эта функция открывает Папку. Значение mailboxName должно быть строкой. Оно указывает имя Папки.
Если имя не начинается с символа ~, то открывается папка у текущего Пользователя (если она существует).
Текущий Пользователь (если есть) должен иметь для указанной папки права доступа Read/Select (Входить).
Функция возвращает описатель Папки, если Папка была успешно открыта; в противном случае возвращается нулевое значение.

OpenMailboxView(params)

Эта функция открывает Папку и создаёт описатель Папки.
Значение params должно быть словарём, в котором содержаться строковые элементы mailbox и sortField; также там могу содержаться опциональные строковые элементы mailboxClass, sortOrder, filter, filterField и числовые элементы UIDValidity, UIDMin.
Дополнительную информацию о значениях этих параметров смотрите в разделе XIMSS .
Функция возвращает описатель Папки, если Папка была успешно открыта; в противном случае возвращается строка с кодом ошибки.

MailboxUIDs(boxRef,flags)

Эта функция возвращает числовой массив с идентификаторами сообщений в папке.
Значение boxRef должно быть описателем Папки.
Если значение flags является строкой, то оно должно содержать разделённый запятой список флагов сообщений Names (имена) и/или Negative Names (Обратные Имена). В результирующий массив включаются только те идентификаторы, сообщения которых имеют флаги, заданные флагом Names и не имеют флагов, заданных в Negative Names.
В следующем примере запрашиваются идентификаторы всех сообщений, которые имеют флаг Seen и не имеют флага Deleted:

myMailbox = OpenMailbox("INBOX");
seen = MailboxUIDs(myMailbox,"Seen,Undeleted");

SubscribeEvents(object,refData)

Эта функция включает или выключает возможность генерирования событий объектом object.
Если значение refData является нулевым, то object прекращает генерирование событий.
В противном случаве, значение refData должно быть "базовым" объектом. Если object генерирует события и отправляет их в эту Задачу, то элемент parameter события содержит значение refData.
Если значением object является описатель Папки, то он должен быть создан функцией OpenMailboxView. Уведомления о Событии Папки отправляется в эту Задачу при удалении, добавлении или изменении сообщений Папки. "Вид папки" фактически не изменяется (то есть, функция MailboxUIDs возвращает тот же набор идентификаторов сообщений) до тех пор, пока к этому описателю Папки не будет применена функиця Sync.

IsMailboxNotifyEvent(data)

Эта функция возвращает значение истина, если значением data является уведомление о Событии Папки; в противном случае функция возвращает нулевое значение.

Sync(boxRef)

Эта функция проверяет наличие изменений в Папке.
Значение boxRef должно быть Описателем Папки.
Эта функция берёт первое из необработанных изменений в Папке и "обрабатывает" его, изменяя UIDы сообщений (добавляя добавленные сообщения, удаляя удалённые сообщения). Функция возвращает словарь, в котором содержатся следующие элементы:

mode: строка removed, added или updated, указывающая на тип изменения Папки.
UID: число - UID удалённого, добавленного изи изменённого сообщения
index: для изменённого сообщения - его позиция в массиве UIDов сообщений.
для удалённого сообщения - его позиция в массиве UIDов сообщений до того, как оно было удалено из этого массива.
для добавленного сообщения - его позиция в массиве UIDов сообщений после того, как оно было добавлено в этот массив.

Если необработанные изменения Папки отсутствуют, то функция возвращает нулевое значение.

MailboxInternalTimeByUID(boxRef,uid)

Эта функция возвращает объект - отметку о времени, в которой содержится Внутренняя Дата сообщения.
Значение boxRef должно быть описателем Папки, значение uid должно быть числом - идентификатором сообщения.
Если сообщение с указанным идентификатором не существует в папке, то функция возвращает нулевое значение.

MailboxFlagsByUID(boxRef,uid)

Эта функция возвращает строку, в которой содержится разделённый через запятую список имён флагов сообщения.
Значение boxRef должно быть описателем Папки, значение uid должно быть числом - идентификатором сообщения.
Если сообщение с указанным идентификатором не существует в папке, то функция возвращает нулевое значение.

MailboxSetFlagsByUID(boxRef,uid,flags)

Эта функция изменяет флаги сообщения папки.
Значение boxRef должно быть описателем Папки, значение uid должно быть числом - идентификатором сообщения, значение flags должно быть разделённым через запятую списком Имён (и/или Обратных Имён) флагов сообщения.
Функция устанавливает флаги, заданные по их Именам и сбрасывает флаги, заданные по их Обратным Именам.
Функция возвращает нулевое значение, если текущий Пользователь (если он есть) имеет достаточные Права Доступа к Папке для изменения флагов и флаги были успешно изменены; в противном случае функция возвращает строку с кодом ошибки.

MailboxExpunge(boxRef)

Эта функция удаляет все сообщения папки, отмеченные как "удалённые".
Значение boxRef должно быть описателем Папки.
Эта функция возвращает нулевое значение, если операция завершилась успешно; в противном случае возвращается строка с кодом ошибки.

MailboxAudioByUID(boxRef,uid)

Эта функция возвращает блок данных, в котором содержится аудио-часть сообщения.
Значение boxRef должно быть описателем Папки, значение uid должно быть числом - идентификатором сообщения.
Если сообщение с указанным идентификатором не существует в папке или если сообщение не имеет части audio, то функция возвращает нулевое значение.

MailboxRedirectByUID(boxRef,uid,addresses)

MailboxForwardByUID(boxRef,uid,addresses)

Эти функции могут использоваться для того, что бы переслать или перенаправить заданные сообщения на указанный адрес электронной почты.
Значение boxRef должно быть описателем Папки, значение uid должно быть числом - идентификатором сообщения, addresses должен быть строкой, содержащий один или несколько адресов электронной почты, разделённых символом запятой (,).
Эти функции возвращают нулевое значение, если операция завершилась успешно; в противном случае ими возвращается строка с кодом ошибки.

MailboxAppend(boxRef,headers,content)

Эта функция создаёт сообщение электронной почты и добавляет его в папку.
Значение boxRef должно быть описателем Папки.
Значения headers и content обрабатываются так же, как в функции SubmitEMail.
Словарь headers может содержать следующие дополнительные элементы:

flags: строка, задающая флаги сообщения, которые создаваемое сообщение будет иметь в Папке. Могут быть указаны несколько флагов, разделённые символом запятой. Дополнительную информацию смотрите в разделе Папки.
internalDate: значение типа отметка о времени с "внутренней отметкой о времени" для создаваемого сообщения. Если оно отсутствует, то используется текущее время.
replacesUID: значение UID с предыдущей версией этого сообщения. Если новое сообщение было успешно создано и добавлено в Папку, то сообщение с UID replacesUID удаляется из Папки.
checkOld: если этот элемент и элемент replacesUID указаны, то операция заканчивается неуспешно если в Папке отсутствует сообщения с UID replacesUID. Эта проверка и операции append/delete выполняются атомарно.
report: если этот элемент задан, то он должен иметь значение uid.

Если значение content является XML объектом vCard или vCardGroup, то запись Контактов создаётся (элементы headers при этом игнорируются), и это запись добавляется в Папку.
Если операция закончилась неуспешно, то эта функция возвращает строку с кодом ошибки.
Если операция заканчивается успешно, то функция возвращает нулевое значение или, если был указан элемент report в словаре headers, функция возвращает число - значение UID для вновь созданного сообщения Папки.

MailboxCopyByUID(boxRef,uid,parameters)

Эта функция копирует или передвигает сообщения электронной почты из одной Папки в какую-нибудь другую Папку.
Значение boxRef должно быть описателем Папки, значение uid должно быть числом - UIDом копируемого сообщения Папки.
Если значением parameters является строка, то она указывает имя Папки-приёмника.
В противном случае, значение parameters должно быть словарём, содержащим следующие элементы:

targetMailbox: строка с именем Папки, в которую будут скопированны или передвинуты сообщения.
doMove: если этот элемент присутствует, то оригинальные сообщение будут удалены после того, как они были успешно скопированны.
mailboxClass: если значением этого элемента является строка, и Папка targetMailbox не существует, то такая Папка будет создана.
Если значением элемента является непустая строка, то это значение используется как Класс Папки для создаваемой Папки.

Эта функция возвращает нулевое значение, если операция завершилась успешно; в противном случае возвращается строка с кодом ошибки.

Описатели Сообщений

Описатели Сообщений являются внутренними объектами, представляющими индивидуальные сообщения, хранящиеся в Папках.

OpenMessage(boxRef,uid)

Эта функция открывает Описатель Сообщения.
Значение boxRef должно быть описателем Папки, значение uid должно быть числом - идентификатором сообщения.
Функция возвращает Описатель Сообщения, если сообщение было успешно открыто; в противном случае возвращается нулевое значение.

MessagePart(msgRef,type)

Значение msgRef должно быть Описателем Сообщения.
Если значение type является нулевым, то эта функция возвращает словарь, содержащий MIME структуры сообщения.
В противном случае, значение type должно быть строкой. В нём указывается искомая подчасть сообщения:

audio: подчасть, где Content-Type имеет тип audio/*
plain: подчасть, где Content-Type имеет тип text/plain.
text: подчасть, где Content-Type имеет тип text/*. Если доступны несколько альтернативных подчастей, то часть с типом text/plain имеет низший приоритет; за ним следует часть text/html.

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

estimatedSize: примерный размер декодированного тела сообщения (или части сообщения).
filename: опционально - имя файла декодированной части сообщения.
Content-Type: тип содержимого сообщения (или части сообщения), такое как text, image, и т.п.)
Content-Subtype: подтип содержимого сообщения (или части сообщения), такое как plain, jpeg, и т.п.)
DispositionParams: словарь с параметрами поля Content-Disposition
ContentTypeParams: словарь с параметрами поля Content-Type
MIMEPartID: Этот элемент является пустой строкой для самого сообщения. Для подчасти сообщения, этот элемент является строкой с идентификатором части сообщения.
MIMEParts: массив MIME подчастей. Каждый элемент массива является словарём, в котором содержится MIME структура подчасти.
contentFieldName: строка со значением поля Content-contentFieldName

MessageHeader(msgRef,partID,fieldName)

Эта функция возвращает массив указанных полей заголовка сообщения или словарь с полями заголовка сообщения. Если сообщение не может быть прочитано или разобрано, то функция возвращает строку с кодом ошибки.
Значение msgRef должно быть Описателем Сообщения.
Если partID имеет нулевое значение, то возвращаются заголовки сообщения.
Если partID является строкой, то она должна быть идентификатором части сообщения и часть сообщения должна иметь тип text/rfc822headers (либо быть подчастью части message/rfc822). Возвращаются заголовки частей сообщения.
Значение fieldName является строкой, оно задаёт имя поле заголовка сообщения, а значением функции является массив с заданными значениями полей.
Иначе, значение msgRef должно быть нулевой строкой. В этом случае значением функции является словарь: ключами словаря являются имена всех полей заголовков сообщения, а их значения - массивы с соответствующими значениями полей.
Если имя поля указывает на поле типа Email (From, To, Sender и т.п.), то каждое значение поля является словарём. Элемент словаря с пустым ключом ("") является разобранным адресом электронной почты. Опциональный элемент realName содержит строку с "комментарием" из адреса.
Если имем поля является E-emailField, где emailField - имя поля типа Email, то значением поля является строка с разобранным адресом электронной почты.
Если именем поля является поле типа дата (Date, ResentDate), то значением поля является отметка о времени.
Во всех других случаях, значениями полей являются MIME-декодированные и перекодированные в кодировку UTF-8 строки, содержащие данные поля.

Пример: Описатель Сообщения msgRef ссылается на сообщение со следующим заголовком:

From: "Sender Name" <fromName@domain>
Subject: I'll be there!
To: "Recipient Name" <toName@domain>, <toName1@domain1>,
To: <toName2@domain2>
Cc: "Cc Name" <toName3@domain3>
MIME-Version: 1.0
X-Mailer: SuperClient v7.77
Date: Fri, 24 Oct 2008 02:51:24 -0800
Message-ID: <ximss-38150012@this.server.dom>
Content-Type: text/plain; charset="utf-8"

Тогда MessageFields(msgRef,"To") возвращает

({""="toName@domain",realName="Sender Name"},{""="toName1@domain1"},{""="toName2@domain2"})

MessageFields(msgRef,"E-Cc") возвращает

("toName3@domain3")

и MessageFields(msgRef,null) возвращает

{
Cc = ({""="toName3@domain3",realName="Cc Name"});
Date = (#T24-10-2008_10:51:24);
From = ({""="fromName@domain",realName="Sender Name"});
Message-ID = ("<ximss-38150012@this.server.dom>");
Subject = ("I'll be there!");
To=({""="toName@domain",realName="Recipient Name"},{""="toName1@domain1"},{""="toName2@domain2"});
X-Mailer = ("SuperClient v7.77");
}

MessageBody(msgRef,partID)

Эта функция возвращает сообщение или тело части сообщения.
Значение msgRef должно быть Описателем Сообщения.
Если partID имеет нулевое значение, то возвращается тело всего сообщения.
Если partID является строкой, то она должна быть идентификатором части сообщения. Возвращается тело части сообщения.
Если сообщение не может быть прочитано или если указанная часть сообщения не найдена, то эта функция возвращает строку с кодом ошибки.
Если типом содержимого сообщения или части сообщения является text/*, то функция перекодирует результат в кодировку UTF-8.
Если типом содержимого сообщения или части сообщения является text/xml, то функция возвращает разобранный XML объект.
Для всех остальных типов содержимого функция возвращает блок данных с данными тела сообщения.

Хранилище Файлов

Следующие функции управляют файлами и файловыми директориями в Хранилище Файлов текущего Пользователя.
Для доступа к Хранилищу Файлов Пользователя, указывайте имя папки или файла как

~account[@domainName]/fileName

ReadSiteFile(fileDescr)

Эта функция читает файл Хранилища Файлов.
Если значением fileDescr является строка, то в ней задаётся имя файла из Хранилища Файлов, который необходимо прочитать. Читается весь файл - и таким способом можно прочитать только те файлы, размер которых не превышает 1 Мб.
Если значением fileName является словарь, то используются следующие элементы словаря:

fileName: строка с именем файла, который необходимо прочитать.
position: опциональный элемент. Его значением должно быть неотрицательное число, которое указывает на позицию в файле (в байтах), с которой необходимо читать файл.
limit: опциональный элемент. Его значение должно быть неотрицательным числом, задающим максимальный размер читаемых данных (в байтах). Если файл короче чем начальная позиция чтения плюс лимит, то читаемый блок данных будет соответственно короче. Это значение не должно превышать 1 Мб.

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

WriteSiteFile(fileDescr,data)

Эта функция сохраняет значение data (которое должно быть строкой или блоком данных) в указанный файл в Хранилище Файлов.
Значение fileDescr является строкой; в ней задаётся имя файла, в который необходимо записать данные. Файл полностью перезаписывается.
Если значением fileName является словарь, то используются следующие элементы словаря:

fileName: строка с именем файла, который необходимо записать
position: опциональный элемент. Если он задан, то файл перезаписывается не полностью.
Если значением этого элемента является неотрицательное число, то оно указывает на позицию в файле (в байтах), с которой необходимо начать запись в файл.
Если значением этого элемента являются строки end или append, то операция записи начинается с текущего конца файла.
Если значением этого элемента является строка new, то операция записи сначала проверяет, что такой файл не существует.

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

AppendSiteFile(fileName,data)

Эта функция добавляет блок данных или строку data в конец файла из Хранилища Файлов с именем fileName.
Если fileName не является строкой или data не является блоком данных, то вызов этой функции приведёт к возникновению исключительной ситуации.
Эта функция возвращает нулевое значение, если файл был успешно записан; в противном случае возвращается строка с кодом ошибки.

DeleteSiteFile(fileName)

Эта функция стирает файл из Хранилища Файлов.
Эта функция возвращает нулевое значение, если файл был успешно удалён; в противном случае возвращается строка с кодом ошибки.

RenameSiteFile(oldFileName,newFileName)

Эта функция переименовывает файл oldFileName из Хранилища Файлов в newFileName. Оба параметра должны иметь строковые значения.
Эта функция возвращает нулевое значение, если файл был успешно переименован; в противном случае возвращается строка с кодом ошибки.

CreateSiteDirectory(directoryName)

Эта функция создаёт директорию directoryName в Хранилище Файлов.
Эта функция возвращает нулевое значение, если директория была успешно создана; в противном случае возвращается строка с кодом ошибки.

RenameSiteDirectory(oldDirectoryName,newDirectoryName)

Эта функция переименовывает директорию oldDirectoryName в Хранилище Файлов в newDirectoryName. Оба параметра должны иметь строковые значения.
Эта функция возвращает нулевое значение, если директория была успешно переименована; в противном случае возвращается строка с кодом ошибки.

DeleteSiteDirectory(directoryName)

Эта функция уничтожает директорию directoryName в Хранилище Файлов. Директория должна быть пустой.
Эта функция возвращает нулевое значение, если директория была успешно удалёна; в противном случае возвращается строка с кодом ошибки.

ListSiteFiles(folderName)

Эта функция возвращает информацию о всех файлах, находящихся в указанной поддиректории Хранилища Файлов.
Если folderName не является строкой, то возвращается информация о директории верхнего уровня Хранилища Файлов текущего Пользователя.
В случае ошибки эта функция возвращает нулевое значение. В противном случае функция возвращает словарь. Каждый ключ словаря является именем поддиректории. Для директорий значение словаря является пустым массивом. Для файлов значение словаря является словарём, в котором содержатся следующие элементы:

STCreated: значение типа отметка о времени, в котором находится дата создания файла.
STModified: значение типа отметка о времени, в котором находится дата изменения файла.
STFileSize: числовое значение, равное размеру файла в байтах.

Ростер

В следующих встроенных функциях реализован интерфейс к Ростеру Пользователя.

ReadRoster(accountName)

Эта функция читает элементы данных Ростера.
Если значение accountName является нулевым, то читается Ростер текущего Пользователя; в противном случае accountName должно быть строкой, указывающей имя Пользователя, чьи элементы данных Ростера будут прочитаны.
Эта функция возвращает словарь с элементами данных Ростера, где ключами словаря являются адреса электронной почты контактов, а значениями словаря будут следующие элементы:

Inp: "входящий" режим подписки: он управляет тем, может ли контакт наблюдать за статусом присутствия пользователя. Возможные значения: нулевое значение, истинно, Pending, Blocked.
Out: "исходящий" режим подписки: он управляет тем, может ли пользователь наблюдать за статусом присутствия контакта. Возможные значения: нулевое значение, истинно, Pending.
RealName: строка с настоящим именем контакта (опционально).

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

SetRoster(params,accountName)

Эта функция изменяет элементы данных Ростера.
Если accountName имеет нулевое значение, то изменяются Ростер текущего Пользователя; в противном случае значением accountName должна быть строка, задающее имя Пользователя, чьи данные необходимо изменить.
Значение params должно быть словарём, содержащим следующие элементы:

peer

строка с адресом электронной почты контакта (accountName@domainName).

what

Строка с типом операции:

update: изменяет информацию контакта.
remove: удаляет контакт из Ростера.
subscribed: подтверждает запрос контакта на наблюдение за информацией о статусе присутствия пользователя.
unsubscribed: отвергает запрос контакта на наблюдение за информацией о статусе присутствия пользователя или забирает ранее предоставленное право на наблюдение.
subscribe: отправляет запрос на наблюдение за информацией о статусе присутствия контакта.
subBoth: подтверждает запрос контакта на наблюдение за информацией о статусе присутствия пользователя и отправляет запрос на наблюдение за информацией о статусе присутствия контакта.
unsubscribe: останавливает наблюдение за информацией о статусе присутствия контакта.

data

опционально - словарь, содержащий новую информацию о контакте.

Наборы Данных

В следующих встроенных функциях реализован интерфейс к Наборам Данных Пользователя. Для доступа к Набору Данных других Пользователей, имя набора данных должно быть задано как ~accountName/datasetName или ~accountName@domainName/datasetName

DatasetList(datasetName,filterField,filterValue): Эта функция читает данные записи из набора данных Пользователя.
Значение datasetName должно быть строкой с именем набора данных.
Значения filterField и filterValue должны быть нулевыми или строками. Если эти значения являются строками, то они указывают на имя и значение записи. В результат включаются только те записи, указанный атрибут которых совпадает с заданным значением.
Эта функция возвращает словарь с записями из набора данных. Ключами словаря являются имена записей, а элементами словаря являются данные записей. Каждая запись данных является словарём, в котором содержатся атрибуты записи данных.
Если записи из набора данных не могут быть прочитаны, то функция возвращает строку с кодом ошибки.
DatasetRemove(datasetName,ifExists): Эта функция удаляет набор данных Пользователя.
Значение datasetName должно быть строкой, задающей имя набора данных.
Если значение ifExists является ненулевым и удаляемый набор данных уже не существует, то функция не возвращает код ошибки.
Если набор данных был успешно удалён, то функция возвращает нулевое значение. В противном случае, функция возвращает строку с кодом ошибки.
DatasetSet(datasetName,entryName,entryData,ifExists): Эта функция изменят записи данных в наборе данных Пользователя.
Значение datasetName должно быть строкой, задающей имя набора данных.
Значение entryName должно быть строкой, задающей имя записи.
Значение entryData должно быть словарём, задающим данные записи (атрибуты).
Если значение ifExists нулевое, то если набор данных не существует, он создаётся; данные с указанными именем также создаются, если они не сушествуют.
Если набор данных был успешно изменён, то функция возвращает нулевое значение. В противном случае, функция возвращает строку с кодом ошибки.
DatasetDelete(datasetName,entryName,ifExists): Эта функция удаляет данные из набора данных Пользователя.
Значение datasetName должно быть строкой, задающей имя набора данных.
Значение entryName должно быть строкой, задающей имя записи.
Если значение ifExists является ненулевым и удаляемые данные набора данных уже не существуют, то функция не возвращает код ошибки.
Если набор данных был успешно удалён, то функция возвращает нулевое значение. В противном случае, функция возвращает строку с кодом ошибки.

Справочник

В следующих встроенных функциях реализован интерфейс к Менеджеру Справочника.

DirectorySearch(baseDN,filter,parameters)

Эта функция выполняет поиск в справочнике, возвращая словарь с найденными записями.
Значение baseDN должно быть строкой с базовым DN поиска. Если это значение равно "$", то для создания Базового DN используются установки Центрального Справочника для текущего Домена.
Значение filter должно быть либо нулевым, либо строкой с фильтром поиска согласно RFC2254.
Значение parameters должно быть либо нулевым, либо словарём, в котором содержатся опции поиска:

limit: Если значением этой опции является положительное число, то оно задаёт максимальное количество возвращаемых записей. Иначе возвращается не более, чем 100 записей.
keys: Если значением этой опции является DN, то ключ результирующего словаря являются Полным DN записи. В противном случае, ключами результирующего словаря являются RDN записи.
scope: Если значением этой опции является sub, то выполняется поиск в поддеревьях. Иначе ищутся только такие записи, для которых Базовый DN является прямым отцом.
attributes: Если значение этой опции является массивом строк, то в результирующие записи включаются только те атрибуты, которые перечислены в этом массиве.
В противном случае, в результирующие записи включаются все атрибуты.

Если операция поиска в справочнике заканчивается неуспешно (отсутствует запись Базового DN, недостаточно прав доступа и т.д.), то функция возвращает строку с кодом ошибки.

Сервисы

GetLanguage(): Значением функции является строка с текущим "выбранным языком".
SetLanguage(lang): Эта процедура устанавливает "выбранный язык". Значением lang должна быть строка с именем языка или нулевое значение для установки языка по умолчанию.
GetTimeZoneName(): Значением функции является строка с текущим "выбранным часовым поясом". Если не выбрано никакого часового пояса (используется часовой пояс сервера), то функция возвращает нулевое значение.
SetTimeZone(zoneName): Эта процедура устанавливает текущий часовой пояс. Значение zoneName должно быть строкой с именем известного часового пояса. Если указывается неизвестное имя часового пояса или значение zoneName не является строкой, то устанавливается фиктивное значение no zone и используется текущий часовой пояс Сервера.
SysLog(arg): Эта процедура записывает в Журнал Сервера текстовое представление значения arg.
SysProfile(arg): Если значение arg является нулевым, то процедура уменьшает внутренний целочисленный счётчик уровня профилирования на 1; в противном случае она увеличивает его на 1.
Счётчик уровня профилилирования при запуске программы устанавливается в ноль.
Если счётчик уровня профилирования имеет положительное значение, то в Журнал Сервера помещаются профилирующие записи при входе во все определённые пользователем (и в некоторые из встроенных функций/процедур), а также при выходе из них.

Коммуникации

HTTPCall(URL,parameters)

string	::=	"string-data"
number	::=	digits
name	::=	alpha-numeric-and-underscore-starting-with-alpha

variable	::=	name

dataRef	::=	variable \| expr [ expr ] \| expr . name \| expr . ( expr )
spawnExpr	::=	spawn name [ ( expr ) ]
basicExpr	::=	string \| number \| null \| false \| true \| dataRef \| expr . name ( [argList] ) \| spawnExpr

unaryOp	::=	! \| not \| - \| +
unary	::=	basicExpr \| unaryOp unary \| ( expr )
multOp	::=	* \| / \| %
multBinary	::=	unary \| multBinary multOp unary
addOp	::=	+ \| -
addBinary	::=	multBinary \| addBinary addOp multBinary
cmpOp	::=	< \| <= \| == \| != \| >= \| >
cmpBinary	::=	addBinary \| cmpBinary cmpOp addBinary
logicOp	::=	& \| and \| \| \| or \| && \| and then \| \|\| \| or else
logicBinary	::=	cmpBinary \| logicBinary logOp cmpBinary
ternary	::=	logicBinary \| logicBinary ? logicBinary : ternary
expr	::=	ternary

argList	::=	expr 0*(, expr)
funcCall	::=	name ( [argList] )
procCall	::=	name ( [argList] ) \| expr . name ( [argList] )

letOp	::=	= \| += \| -= \| *= \| /= \| %= \| \|= \| &=
letOper	::=	dataRef letOp expr

nullOper	::=	\| null
stopOper	::=	stop
returnOper	::=	return [ expr ]

ifOper	::=	if expr then opSequence 0( elif* expr then opSequence ) [ else opSequence ] end [ if ]
altIfOper	::=	if expr { opSequence } 0( elif* expr { opSequence } ) [ else { opSequence } ]

loopOper	::=	[while expr ] loop opSequence 0( exitif* expr ; opSequence) end [ loop ]
altLoopOper	::=	while expr { opSequence 0( exitif* expr ; opSequence) }

oper	::=	nullOper \| procCall \| letOper \| returnOper \| stopOper \| ifOper \| loopOper
altOper	::=	altIfOper \| altLoopOper
seqOper	::=	oper ; \| altOper
opSequence	::=	0*( seqOper )

entryBody	::=	forward ; \| is opSequence end [ entry ] ; \| { opSequence }
procBody	::=	forward ; \| external ; \| is opSequence end [ procedure ] ; \| { opSequence }
funcBody	::=	forward ; \| external ; \| is opSequence end [ function ] ; \| { opSequence }
parmList	::=	name 0*(, name)
entry	::=	entry name entryBody
procedure	::=	procedure name ( [ paramlist] ) procBody
функция	::=	function name ( [ paramlist] ) funcBody

program	::=	1*(entry \| procedure \| function)

Альтернативные Формы

Точки Входа

Процедуры

Функции

Строки

Числа

Отметки о Времени

IP Адреса

Блоки Данных

Массивы

Словари

XML Объекты

Преобразование Данных

Среда

Адреса и URI

Данные Пользователя

Папки

Описатели Папок

Описатели Сообщений

Хранилище Файлов

Ростер

Наборы Данных

Справочник

Сервисы

Коммуникации

Язык Программирования CommuniGate Pro (CG/PL)

Модель Данных

Лексемы

Переменные

Выражения

Операторы

Разделы программы

Встроенные Процедуры и Функции

Многозадачность

Порождение

События

Встречи

Очереди

Формальный Синтаксис