БАЗОВЫЕ ФУНКЦИИ И ПРОЦЕДУРЫ

Перечисленные здесь функции и процедуры, являются базовыми в ИБС "Бисквит" и описаны в процедуре base-pp.p, которая вызывается как PERSISTENT c процедурным указателем h_base. Инклюд-файл basefunc.def содержит объявление данных функции, который в свою очередь определен в globals.i. Следовательно, для использования данных функции в своих процедурах достаточно объявления в них globals.i



ФУНКЦИИ


GetXAttrValue(in-FileName, in-Surr, in-Code) – возвращает значение доп. реквизита,CHAR типа. Если доп. реквизит отсутствует (не заполнен), то возвращается пустая строка.

  • in-FileName – имя таблицы объекта (пример: person, cust-corp,acct), тип CHAR;
  • in-Surr – чей доп. реквизит (суррогат1), тип CHAR;
  • in-Code – код доп. реквизита, тип CHAR.

GetXAttrValueEx(in-FileName, in-Surr, in-Code, in-nofound) – возвращает значение доп. реквизита, а при отсутствии такового, указанное в in-nofound значение CHAR типа.

  • in-FileName – имя таблицы объекта (пример:person,cust-corp,acct);
  • in-Surr – чей доп. реквизит (суррогат1);
  • in-Code – код доп. реквизита;
  • in-nofound – результат функции при отсутствии доп. реквизита.

GetTempXAttrValue(in-FileName, in-Surr, in-Code) – возвращает значение темпорированного доп. реквизита на глобальную дату (т.е. на дату "Конец периода" указанную в CTRL+K, gend-date), тип CHAR. Если доп. реквизит отсутствует, возвращается пустая строка.

  • in-FileName – имя таблицы объекта (пример:person,cust-corp,acct), тип CHAR;
  • in-Surr – чей доп. реквизит (суррогат1), тип CHAR;
  • in-Code – код доп. реквизита, тип CHAR.

GetTempXAttrValueEx(in-FileName, in-Surr, in-Code, in-Date, in-nofound) – возвращает значение темпорированного доп. реквизита на указанную дату, тип CHAR. Если доп. реквизит отсутствует (не заполнен), возвращается значение указанное в in-nofound.

  • in-FileName – имя таблицы объекта (пример: person, cust-corp, acct);
  • in-Surr – чей доп. реквизит (суррогат1), тип CHAR;
  • in-Code – код доп. реквизита, тип CHAR;
  • in-Date – дата, на которую ищется значение темпорированного доп. реквизита, тип DATE;
  • in-nofound – результат функции при отсутствии доп. реквизита, тип CHAR.

GetXAttrSurr(in-FileName, in-Code, in-Value) – возвращает список объектов определенного класса у которых указанный доп.реквизит имеет указанное значение, тип CHAR.

  • in-FileName – имя таблицы объекта (пример:person,cust-corp,acct), тип CHAR;
  • in-Code – код доп. реквизита, тип CHAR;
  • in-Value – значение доп. реквизита, тип CHAR.

getPrinter – возвращает имя принтера текущего пользователя, тип CHAR.


getUserPrinter(usr_name) – возвращает значение принтера указанного пользователя, тип CHAR.

  • usr_name – имя пользователя значение имени принтера которого необходимо определить. Значение типа CHAR.

getUserBranchId (usr_name) – возвращает код подразделения к которому относится текущий пользователь, тип CHAR.

  • usr_name – имя пользователя CHAR типа.

getUserBranchId(usr_name, XAttr-Code) – возвращает значение заданного доп. реквизита указанного пользователя, тип CHAR. 

  • usr_name – имя пользователя;
  • XAttr-Code – код доп. реквизита.

getThisUserXAttrValue(XAttr-Code) - возвращает значение заданного доп. реквизита текущего пользователя, тип CHAR.

  • XAttr-Code – код доп. реквизита, CHAR типа.

getUserSlaves(usr_name) – возвращает список подчиненных указанного пользователя, тип CHAR.

  • usr_name – имя пользователя CHAR типа;

getSlaves – возвращает список подчиненных текущего пользователя, тип CHAR.


isUserAdm(usr_name) – возвращает является ли текущий пользователь Администратором, тип LOGICAL (YES - является, NO - не является).

  • usr_name – имя пользователя CHAR типа.

Holiday(iDate) – возвращает логическое значения является ли указанная дата выходным днем или нет, тип LOGICAL.

  • iDate – проверяемая дата, типа DATE.

term2str(in-beg-date, in-end-date) – возвращает указанный период строкой, тип CHAR.

  • in-beg-date дата начала периода, тип DATE;
  • in-end-date – даты конца периода, тип DATE.
{globals.i}
DEF VAR beg-date AS DATE NO-UNDO.

DEF VAR end-date AS DATE NO-UNDO.
beg-date = 01/01/2012.
end-date = 03/31/2012.
DISPLAY term2str(beg-date, end-date) FORMAT "x(20)".

Результат1 квартал 2012 г.


term2strEng(in-beg-date, in-end-date) – возвращает указанный период строкой, тип CHAR.

  • in-beg-date дата начала периода, тип DATE;
  • in-end-date – даты конца периода, тип DATE.
{globals.i}
DEF VAR beg-date AS DATE NO-UNDO.

DEF VAR end-date AS DATE NO-UNDO.
beg-date = 01/01/2012.
end-date = 03/31/2012.
DISPLAY term2strEng(beg-date, end-date) FORMAT "x(20)".

Результат1 quarter 2012


per2str(in-beg-date, in-end-date) – возвращает наименование периода, тип CHAR.

  • in-beg-date дата начала периода, тип DATE;
  • in-end-date – даты конца периода, тип DATE.
{globals.i}
DEF VAR beg-date AS DATE NO-UNDO.

DEF VAR end-date AS DATE NO-UNDO.
beg-date = 01/01/2012.
end-date = 03/31/2012.
DISPLAY per2str(beg-date, end-date) FORMAT "x(20)".

РезультатКвартал


WhoLocks2(rec_id, tab_name, ioStr) – возвращает логическое значение заблокирована ли запись, и если да то так же строку с информацией кем заблокирована, тип LOGICAL.

  • rec_id  ID проверяемой записи типа RECID;
  • tab_name  таблица записи, тип CHAR;
  • ioStr  input-output параметр, строка к которой будет добавлена информации кем заблокирована запись, тип CHAR.

FGetSetting(ipCode, ipSubCode, ipDefValue) - возвращает значение настроечного параметра, а при его отсутствии указанное значение по умолчанию. Для многофилиальной базы, возвращается значение настроечного параметра для филиала определенного в глобальной переменной shFilial. При этом необходимо учитывать, что первоначально значение ищется в кэше.

  • ipCode - код параметра, тип CHAR;
  • ipSubCode - код подпараметра, тип CHAR;
  • ipDefValue - значение по умолчанию, тип CHAR.

FGetSettingMF(ipCode, ipSubCode, ipDefValue, ipFilial, ipNoCashe) - возвращает значение настроечного параметра, для указанного филиала в многофилиальной базе, а при его отсутствии, указанное значение по умолчанию, тип CHAR.

  • ipCode - код параметра, тип CHAR;
  • ipSubCode - код подпараметра, тип CHAR;
  • ipDefValue - значение по умолчанию, тип CHAR;
  • ipFilial - код филиала, тип CHAR;
  • ipNoCasch -  не искать в кэше (YES - не искать в кэше; NO - искать в кэше), тип LOGICAL.

FGetSettingEx(ipCode, ipSubCode, ipDefValue, ipMessMode) - возвращает значение настроечного параметра, а при его отсутствии указанное значение по умолчанию, тип CHAR. В случае если настроечный параметр не найден так же возможен вывод соответствующего сообщения "Не найден настроечный параметр ..."

  • ipCode - код параметра, тип CHAR;
  • ipSubCode - код подпараметра, тип CHAR;
  • ipDefValue - значение по умолчанию, тип CHAR;
  • ipMessMode - выводить сообщение если параметр не найден, тип LOGICAL.

FGetSettingDetails(ipCode, ipSubCode, ipDefValue) - возвращает описание настроечного параметра, а при его отсутствии указанное значение по умолчанию, тип CHAR.

  • ipCode - код параметра, тип CHAR;
  • ipSubCode - код подпараметра, тип CHAR;
  • ipDefValue - значение по умолчанию, тип CHAR.

 


1 Что является суррогатом для объекта см. surr.i

Вы здесь: Главная ИБС Бисквит БАЗОВЫЙ БАЗОВЫЕ ФУНКЦИИ И ПРОЦЕДУРЫ