Admin: 1 revision imported

2021-02-07T06:43:16Z

1 revision imported

Admin: /* Аргументы */

2020-06-08T15:33:06Z

‎Аргументы

New page

{{infobox function
|name=ClearStorages
|object=[[Объект базы данных]]
|caption=Работа с накопителями документа
|type=1
|status=2
|db=2
|exception=Невозможно превратить в число, строку, неверные накопители, накопители уже заблокированы.
|visual=0}}
{{HeadLinks|
* [[Main_Page|Начальная страница]]
* [[Общее_описание_языка|Общее описание]]
* [[Объекты]]
* [[Объект базы данных]]}}
Функция производит удаление движений текущего документа из указанного накопителя или всех накопителей, в которых текущий документ имеет движения. Если вызов функции происходит внутри транзакции, накопители будут автоматически заблокированы. Функция обычно используется внутри модулей обработки документов. {{Алгоритмы обработки документов}}

== Синтаксис ==
<code>
{{Grey|DB.}}'''ClearStorages'''({{Optional|<Режим (INT)>{{Default|{{Eq}}1}},<Наименования накопителей (STRING)>}})
</code>

==== Аргументы ====
* <code>''<Режим (INT)>''</code> - Задает режим работы функции, доступны следующие значения:
** '''0''' -- Удалить движения только из накопителей не заблокированных в данный момент. '''Внимание''': этот режим опасен для использования, он будет неверно работать в событии обработки документа при наличии вложенных транзакций, так как используется общая для всех документов транзакции блокировка накопителей, это может привести к тому, что движения какой-либо накопителя, заблокированного в другом документе, не будут удалены. Режим никогда не должен использоваться внутри события обработки (или отмены обработки) документов.
** '''1''' (по умолчанию) -- Удалить движения из всех накопителей данного документа. Внутри транзакции этот режим блокирует все накопители, в которые возможна запись из текущего документа, поэтому этот режим может быть не самым выгодным с точки зрения времени удержания накопителей. Режим совместим с [[Студия/Конфигурация данных проекта|порядком блокировки накопителей]].
** '''2''' -- Удалить движения из всех накопителей документа, кроме тех, которые перечислены во втором аргументе. Режим совместим с [[Студия/Конфигурация данных проекта|порядком блокировки накопителей]].
** '''3''' -- Удалить движения только из тех накопителей, которые перечислены во втором аргументе. Режим совместим с [[Студия/Конфигурация данных проекта|порядком блокировки накопителей]].
* <code>''<Наименования накопителей (STRING)>''</code> - Наименования накопителей, разделенные запятой. Документ может иметь движения только в накопителях, заданных для этого документа в Студии.

== Примеры ==
<pre>
//Пример для документа аДок, который обрабатывает документ вне стандартного события обработки документа.
//Пример демонстрирует алгоритм, описанный выше.
//Созданные заранее таблицы с накопителями документа содержатся в списке спНакопители
//Данный пример больше подходит для загрузки документов вместе с движения из внешнего источника, так как нет блока проверки корректности данных

//Флаг успешной транзакции
ФлОк:=0;
BeginTransaction();
Try
//Бесконечный цикл ожидания блокировки накопителей документа
While 0=0 Do
Try
аДок.ClearStorages();
Except
RollbackTransaction();
Sleep(100);
BeginTransaction();
Continue;
EndTry;
Break;
EndDo;
//Установка пометки обработки
аДок.PublishedMark(1);

//Запись движений в накопители
For i:=1 To спНакопители.Size() Do
aTab:=спНакопители.Get(i);
ИмяНак:=спНакопители.GetName(i);
If aTab.Size()>0 Then
аДок.SaveStorage(ИмяНак,aTab,аДок.DocDate);
EndIf;
EndDo;

//Сохранение документа
аДок.Save();
//Транзакция успешна
ФлОк:=1;
Finally
If ФлОк Then
CommitTransaction();
Else
RollbackTransaction();
EndIf;
EndTry;
</pre>

← Older revision	Revision as of 06:43, 7 February 2021
(No difference)

DB.ClearStorages - Revision history

Admin: 1 revision imported

Admin: /* Аргументы */