DB.UseDate

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

Функция возвращает или меняет внутреннюю дату отображения и загрузки периодических реквизитов (дату окончания периода периодических реквизитов объекта), при этом, после изменения, функция автоматически перечитывает значения периодических реквизитов объекта на новую дату, если второй аргумент равен 1, либо по умолчанию, если для объекта выбран режим загрузки периодических реквизитов или, если объект связан с элементом формы. Даты начала записи реквизитов и окончания записи (отображения) периодических реквизитов хранятся для каждого из объектов базы данных в отдельности внутри объекта и копируются туда из дат, закрепленных за текущим потоком (см. функции GlobalBegPeriodDate, GlobalEndPeriodDate и BegPeriodDate, EndPeriodDate).

Синтаксис

DB.UseDate(<Дата периодических реквизитов объекта (DATE)>,<Обновить периодические реквизиты (в том числе на форме) (INT)>):<Предыдущая дата периодических реквизитов объекта (DATE)>

Аргументы

  • <Дата периодических реквизитов объекта (DATE)> - (необязательный аргумент) Устанавливает новую дату отображения периодических реквизитов объекта, без этого аргумента, функция не будет изменять дату.
  • <Обновить периодические реквизиты (в том числе на форме) (INT)> - (необязательный аргумент) Обновляет периодические реквизиты объекта, если они загружены совместно с обычными реквизитами, также обновляет видимые реквизиты на форме, если объект является редактируемым визуальным объектом. Данный параметр будет установлен по умолчанию в 1, если объект редактируется визуально или для объекта включена опция загрузка периодических реквизитов, и равен 0 по умолчанию, в ином случае.

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

Возвращается предыдущая дата отображения периодических реквизитов объекта.

Примеры

//aEl -- редактируемый объект базы данных
aEl:=Form.Object;
Message("Периодически реквизиты объекта отражаются на дату "+aEl.UseDate());