Описание встроенного языка системы 1С Предприятие


СтатусВозврата


Установить/определить статуса возврата предопределенной процеду­ры.

Синтаксис:

СтатусВозврата([<Статус>])

Англоязычный синоним:

ReturnStatus

Параметры:

<Статус>

Необязательный параметр. Числовое выражение. Если задано значение 1, то устанавливается статус возврата — Выполнить Действие. Если задано зна­чение 0, то устанавливается статус возврата — Отменить Действие. Если параметр опущен, то статус возврата предопределенной процедуры не меняется.

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

Число 1 — если статус возврата — Выполнить Действие;

Число 0 — если статус возврата — Отменить Действие.

Описание:

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

Значение статуса возврата предопределенной процедуры используется сис­темой при завершении отработки любой предопределенной процедуры, чтобы определить, выполнять ли системно событие, которое вызвало данную предо­пределенную процедуру.

Замечание: Начальное значение статуса возврата предопределенной процеду­ры равно 1 (Выполнить Действие), которое устанавливается системой при вызове предопределенной процедуры.

В тексте программного модуля возможно использование данного оператора как процедуры или как функции. При использовании в качестве функции, воз­вращаемое значение соответствует текущему статусу возврата предопределен­ной процедуры, которое было до вызова данной функции. В данном случае па­раметр <Статус> можно опускать.

Если параметр <Статус> задан явно, то после выполнения данной функ­ции статус возврата установится в заданное значение. Пример:

* Если в предопределенной процедуре ПриЗаписи установить статус возвра­та — 0 (например, если неверно заполнены реквизиты), то документ не бу­дет записываться.

Процедура ПриЗаписи()




Начало  Назад  Вперед