OnSaveDBVar

From SunFlurry wiki
Jump to: navigation, search
  OnSaveDBVar (События базы данных)
Статус разработки: Реализована
Тип:Функция
Обращение к БД:Нет
Расположение:Любой глобальный модуль
Визуальность:Да

Событие, вызываемое в момент сохранения изменений в редакторе глобальных переменных БД. Запись будет запрещена, если функция возвратит единицу. Для периодических переменных событие будет вызвано только для изменения значения переменной непосредственно из редактора, а не для изменений в редакторе периодических значений, который вызывается с помощью дополнительной кнопки с иконкой часов (для последнего, см. событие OnOpenPeriodicalsEditor). См. также описание атрибута ReadOnly.

Синтаксис

OnSaveDBVar(<Имя переменной БД (STRING)>,<Новое значение>,<Начало периода записи (DATE)>,<Окончание периода записи (DATE)>):<Запретить запись (INT)>

Аргументы

  • <Имя переменной БД (STRING)> - Идентификатор переменной БД, для которой происходит изменение значения
  • <Новое значение> - Значение, на которое происходит изменение
  • <Начало периода записи (DATE)> - (необязательный аргумент) Для периодических переменных указывает на начало периода изменения. Для обычных переменных не имеет смысла (однако, также передается).
  • <Окончание периода записи (DATE)> - (необязательный аргумент) Для периодических переменных указывает на окончание периода изменения. Для обычных переменных не имеет смысла (однако, также передается).

Возвращаемое значение

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


Примеры

Function OnSaveDBVar(DBVarName,NewDBVarValue,SavePeriodBeg,SavePeriodEnd)
  If not глПользователь.общиеАдминистратор Then
    Message("Вам запрещено изменять установки БД, обратитесь к администратору!","!");
    Exit 1;
  EndIf;
  Exit 0;
EndFunction