ПакетОтображаемыхДокументов.НачатьЗапись (RepresentableDocumentBatch.BeginWriting)

ПакетОтображаемыхДокументов (RepresentableDocumentBatch)

НачатьЗапись (BeginWriting)

Доступен, начиная с версии 8.3.12.

Синтаксис:

НачатьЗапись(<ОписаниеОповещения>, <ИмяФайла>, <ТипФайла>)

Параметры:

<ОписаниеОповещения> (необязательный)

Тип: ОписаниеОповещения.
Содержит описание процедуры, которая будет вызвана после завершения записи файла со следующими параметрами:

<Результат> - результат операции:
- Истина, если запись была инициирована с помощью расширений для браузера и пользователь согласился на его получение, то есть запись файла была завершена;
- Ложь, если запись была инициирована с помощью расширений для браузера, но пользователь не согласился на его получение, то есть запись файла не была завершена;
- Неопределено, если запись была инициирована скачиванием файла средствами браузера и неизвестно, был ли файл записан или нет;
<ДополнительныеПараметры> - значение, которое было указано при создании объекта ОписаниеОповещения.

Если параметр не указан или имеет тип Неопределено, то по завершении никакая процедура вызвана не будет.

<ИмяФайла> (обязательный)

Тип: Строка.
Содержит полное имя файла, в который нужно записать пакет отображаемых документов.

<ТипФайла> (обязательный)

Тип: ТипФайлаПакетаОтображаемыхДокументов.
Содержит формат файла, в котором будет сохранен пакет отображаемых документов.

Описание:

Вызывает начало записи пакета отображаемых документов в файл.

Доступность:

Тонкий клиент, веб-клиент, мобильный клиент, сервер, толстый клиент, внешнее соединение, мобильное приложение (клиент), мобильное приложение (сервер), мобильный автономный сервер.

См. также:

ПакетОтображаемыхДокументов, метод Записать
ПакетОтображаемыхДокументов, метод ЗаписатьАсинх

Использование в версии:

Доступен, начиная с версии 8.3.12.

Описание изменено в версии 8.3.18.

Методическая информация