БИБЛИОТЕКА РАБОТЫ С МЕТАСХЕМОЙ


ФУНКЦИИ



ФУНКЦИИ РАБОТЫ С КЛАССИФИКАТОРАМИ


GetCode(inClass, inCode) - возвращает значение указанного кода параметра классификатора, тип CHAR .

  • inClass - код классификатора, тип CHAR;
  • inCode - код параметра, тип CHAR.

GetCodeEx(inClass, inCode, inReturn) - возвращает значение кода параметра классификатора, а при отсутствии такового указанное значение, тип CHAR.

  • inClass - код классификатора, тип CHAR;
  • inCode - код параметра, тип CHAR;
  • inReturn - возвращаемое значение если указанный кода параметра не найдет в классификаторе, тип CHAR.

AvailCode(ipClass, ipCode) - возвращает логическое значение, тип LOGICAL, отражающее наличие в классификаторе записи с указанным кодом параметра.

  • inClass - код классификатора, тип CHAR;
  • inCode - код параметра, тип CHAR.

GetCodeName(inClass, inCode) - возвращает наименование параметра кода классификатора, тип CHAR.

  • inClass - код классификатора, тип CHAR;
  • inCode - код параметра, тип CHAR.

GetCodeNameEx(inClass, inCode, inReturn) - возвращает наименование параметра кода классификатора, а при отсутствии такового указанное значение, тип CHAR.

  • inClass - код классификатора, тип CHAR;
  • inCode - код параметра, тип CHAR;
  • inReturn - возвращаемое значение, если указанный код параметра не найдет в классификаторе, тип CHAR.

GetCodeVal(iClass, iVal) - возвращает первый найденный код параметра классификатора, соответствующего указанному значению, тип CHAR.

  • iClass - код классификатора, тип CHAR;
  • iVal - значение, тип CHAR.

GetCodeValList(iClass, iVal)возвращает список кодов параметра классификатора, соответствующих указанному значению, тип CHAR.

  • iClass - код классификатора, тип CHAR;
  • iVal - значение, тип CHAR.

GetCodeMisc(ipClassChar, ipCodeChar, ipPosInt)возвращает значение указанного элемента дополнительного значения классификатора, тип CHAR.

  • ipClassChar - класс классификатора, тип CHAR;
  • ipCodeChar - код классификатора, тип CHAR;
  • ipPosInt - номер элемента дополнительного значения, тип INT64.

GetCodeMiscEx(iClass, iCode, iPos, iReturn) - возвращает значение указанного элемента дополнительного значения классификатора, а в случае его отсутствия, указанное значение, тип CHAR.

  • iClass - класс классификатора, тип CHAR;
  • iCode - код классификатора, тип CHAR;
  • iPos- номер элемента дополнительного значения, тип INT64;
  • iReturn - возвращаемое значение при отсутствии искомого, тип CHAR.

GetCodeDesc(ipClassChar, ipCodeChar, ipPosInt, inReturn) - возвращает значение указанного элемента описания классификатора, а в случае его отсутствия, указанное значение, тип CHAR.

  • iClass - класс классификатора, тип CHAR;
  • iCode - код классификатора, тип CHAR;
  • iPos- номер элемента описания классификатора, тип INT64;
  • iReturn - возвращаемое значение при отсутствии искомого, тип CHAR.

 



ФУНКЦИИ РАБОТЫ С КЛАССАМИ МЕТАСХЕМЫ


GetXclassFile(io-class) - возвращает наименование таблицы указанного класса метасхемы, тип CHAR.

  • io-class - класс метасхемы, тип CHAR.


ФУНКЦИИ РАБОТЫ С РЕКВИЗИТАМИ КЛАССА МЕТАСХЕМЫ


GetXattrInit(inClass, inCode) - возвращает начальное значение реквизита класса метасхемы, тип CHAR.

  • inClass - класс метасхемы, тип CHAR;
  • inCode - код реквизита, тип CHAR.

IsTemporal(iTable, iXAttr) - определяет, является ли доп. реквизит темпорированным, или нет. Возвращает логическое значение, тип LOGICAL: YES - доп.реквизит темпорированный; NO - доп. реквизит не является темпорированным.

  • iTable - таблица класса которому принадлежит доп. реквизит, тип CHAR;
  • iXAttr - код доп. реквизита, тип CHAR.

IsXAttrIndexed(cname, ccode) - определяет, является ли указанный доп. реквизит индексированным, или нет. Возвращает логическое значение, тип LOGICAL: YES - доп. реквизит индексированный; NO - доп. реквизит не индексированный; ? (неизвестное значение) - доп. реквизит не найден.

  • cname - класс метасхемы, которому принадлежит доп. реквизит, тип CHAR;
  • ccode - код доп. реквизита, тип CHAR.

UpdateTempSigns(inFile, inSurr, inCode, inVal, inIndexed) - функция создания/редактирования темпорированного доп. реквизита на глобальную дату. Возвращает логическое значение, отражающее успешность выполнения операции - YES, не успешность - NO, или - ? (неизвестное значение), если доп. реквизит не является темпорированным, тип LOGICAL.

  • inFile - таблица/класс объекта, чей доп. реквизит, тип CHAR;
  • inSurr - суррогат объекта, тип CHAR;
  • inCode - код доп. реквизита, тип CHAR;
  • inVal - устанавливаемое значение, тип CHAR;
  • inIndexed - признак индексированного доп. реквизита, тип LOGICAL.

UpdateTempSignsEx(inFile, inSurr, inCode, inDate, inVal, inIndexed) - функция создания/редактирования темпорированного доп. реквизита на заданную дату InDate. Возвращает логическое значение, отражающее успешность выполнения операции - YES, не успешность - NO, или - ? (неизвестное значение), если доп. реквизит не является темпорированным, тип LOGICAL.

  • inFile - таблица/класс объекта, чей доп. реквизит, тип CHAR;
  • inSurr - суррогат объекта, тип CHAR;
  • inCode - код доп. реквизита, тип CHAR;
  • InDate - дата доп. реквизита, тип DATE;
  • inVal - устанавливаемое значение, тип CHAR;
  • inIndexed - признак индексированного доп. реквизита, тип LOGICAL.

UpdateSigns(inFile, inSurr, inCode, inVal, inIndexed) - функция создания/редактирования/удаления значения доп. реквизита. Возвращает логическое значение, отражающее успешность (YES), или не успешность (NO), выполнения операции, тип LOGICAL.

  • inFile - таблица/класс объекта, чей доп. реквизит, тип CHAR;
  • inSurr - суррогат объекта, тип CHAR;
  • inCode - код доп. реквизита, тип CHAR;
  • inVal - устанавливаемое значение, тип CHAR;
  • inIndexed - признак индексированного доп. реквизита, тип LOGICAL.

Для всех описанных выше функции изменения значения доп. реквизита, предварительно, по возможности, необходимо определить является ли изменяемый доп. реквизит индексируемым или нет. Если определить это не представляется возможным, в параметре inIndexed необходимо указать - ? (неопределенное значение), в параметре inFile при этом должен быть указан класс объекта, чей доп. реквизит мы изменяем.

Если заранее известно (удалось определить) является ли изменяемый доп. реквизит индексированным или нет, то значение параметра inIndexed должно быть равно: YES - доп. реквизит является индексированным, или NO - доп. реквизит не индексированный. При этом, в параметре inFile должна быть указана таблица класса объекта, чей доп. реквизит мы изменяем.


UpdateSignsEx(inFile, inSurr, inCode, inVal) - функция создания/редактирования/удаления значения доп. реквизита. Возвращает логическое значение, отражающее успешность (YES), или не успешность (NO), выполнения операции, тип LOGICAL.

  • inFile - класс объекта, чей доп. реквизит, тип CHAR;
  • inSurr - суррогат объекта, тип CHAR;
  • inCode - код доп. реквизита, тип CHAR;
  • inVal - устанавливаемое значение, тип CHAR;

Функция UpdateSignsEx в отличие от UpdateSigns не требует предварительного определения, является ли изменяемый доп. реквизит индексированным, или нет. в параметре inFile функции UpdateSignsEx указывается исключительно класс объекта, чей доп. реквизит мы изменяем. Не смотря на удобство использования данной функции, пользоваться ей рекомендуется только в редких случаях, так как UpdateSignsEx является медленной функцией.


DelAllSigns(infile, insurr) - удаляет все доп. реквизиты заданного объекта. Результатом функции является логическое значение, тип LOGICAL, отражающее успешность/не успешность выполнения операции.

  • infile - таблица класса объекта, тип CHAR;
  • insurr - суррогат объекта, тип CHAR.

 


ПРОЦЕДУРЫ


 

ПРОЦЕДУРЫ РАБОТЫ С РЕКВИЗИТАМИ КЛАССА


CopySigns(iSrcClass, iSrcSurr, iTrgClass, iTrgSurr) - осуществляет копирование всех доп. реквизитов с одного объекта класса метасхемы на другой объект.

  • iSrcClass - класс объекта источника, тип CHAR;
  • iSrcSurr - суррогат объекта-источника, тип CHAR;
  • iTrgClass - класс объекта-приемника, тип CHAR;
  • iTrgSurr - суррогат объекта-приемника, тип CHAR.

CopySignsEx(iSrcClass, iSrcSurr, iTrgClass, iTrgSurr, iInclList, iExclList) - осуществляет копирование доп. реквизитов, заданных маской в формате CAN-DO, с одного объекта класса метасхемы на другой объект.

  • iSrcClass - класс объекта источника, тип CHAR;
  • iSrcSurr - суррогат объекта-источника, тип CHAR;
  • iTrgClass - класс объекта-приемника, тип CHAR;
  • iTrgSurr - суррогат объекта-приемника, тип CHAR;
  • iInclList - маска реквизитов в формате CAN-DO, значения которых копировать, тип CHAR;
  • iExclList - маска реквизитов в формате CAN-DO, значения которых не копировать, тип CHAR.

 

ПРОЦЕДУРЫ РАБОТЫ С МЕТОДАМИ


GetClassMethod(iClassCode, iClassMthd, iXattrCode, iMthdCode, oProcName, ProcPrm) - определяет процедуру метода класса/реквизита и ее параметры, с учетом метода по умолчанию.

  • iClassCode - код класса метасхемы, тип CHAR;
  • iClassMthd - код метода класса, тип CHAR;
  • iXattrCode - код реквизита класса, тип CHAR;
  • iMthdCode - код метода реквизита, тип CHAR;
  • oProcName - процедура метода, тип CHAR;
  • oProcPrm - параметры процедуры метода, тип CHAR.

RunClassMethod(in-class, in-method, in-xattr-code, in-method-code, in-proc-name, params) - осуществляет вызов процедуры метода.

  • in-class - код класса метасхемы, тип CHAR;
  • in-method - код метода класса, тип CHAR;
  • in-xattr-code - код доп. реквизита CHAR;
  • in-method-code - код метода реквизита, тип CHAR;
  • in-proc-name - процедура по умолчанию, тип CHAR;
  • params - параметры процедуры метода, тип CHAR.

 

ПРОЦЕДУРЫ РАБОТЫ СО СВЯЗЯМИ

 

Вы здесь: Главная ИБС Бисквит БАЗОВЫЙ БИБЛИОТЕКИ ИНТЕРФЕЙСОВ БИБЛИОТЕКА РАБОТЫ С МЕТАСХЕМОЙ