Глобальный контекст.НачатьПомещениеФайлов (Global context.BeginPuttingFiles)

Глобальный контекст (Global context)

НачатьПомещениеФайлов (BeginPuttingFiles)

Не рекомендуется использовать, начиная с версии 8.3.15.

Рекомендуется использовать:

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

Синтаксис:

НачатьПомещениеФайлов(<ОписаниеОповещенияОЗавершении>, <ПомещаемыеФайлы>, <Интерактивно>, <УникальныйИдентификаторФормы>, <ОписаниеОповещенияПередНачаломПомещенияФайлов>, <ОписаниеОповещенияОХодеВыполнения>)

Параметры:

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

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

<ПомещенныеФайлы> – массив объектов типа ОписаниеПереданногоФайла или Неопределено, если файлы не получены.
<ДополнительныеПараметры> - значение, которое было указано при создании объекта ОписаниеОповещения.

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

Тип: Массив, ДиалогВыбораФайла, Строка.
Параметр может содержать массив объектов типа ОписаниеПередаваемогоФайла, или массив объектов типа СсылкаНаФайл, или объект типа ДиалогВыбораФайла или Строка.
Для массива объектов типа ОписаниеПередаваемогоФайлав зависимости от его содержимого изменяется хранилище, в котором файлы будут сохранены:

Массив объектов может быть заполнен полностью. - В этом случае известен набор помещаемых файлов и адреса, по которым они должны быть сохранены.
Массив объектов может содержать только имена элементов. - В этом случае, набор помещаемых файлов определен, а места хранения неизвестны. Файлы будут размещены в новых временных хранилищах.

Если параметр задан строкой, то эта строка должна иметь вид строки поиска для метода НайтиФайлы.
Параметр <ПомещаемыеФайлы> указывается в зависимости от значения параметра <Интерактивно>:

Если параметр <Интерактивно> имеет значение Истина, параметр <ПомещаемыеФайлы> может быть не задан или должен иметь тип ДиалогВыбораФайла.
Если параметр <Интерактивно> имеет значение Ложь, то параметр <ПомещаемыеФайлы> должен быть задан и иметь тип Строка или массив объектов типа ОписаниеПередаваемогоФайла, или массив объектов типа СсылкаНаФайл.

В веб-клиенте, если расширение работы с файлами не установлено, то параметр <ПомещаемыеФайлы> должен иметь тип ДиалогВыбораФайла или массив объектов типа СсылкаНаФайл.

<Интерактивно> (необязательный)

Тип: Булево.
Указывает использование интерактивного режима, при котором пользователю показывается диалог, в котором он может выбрать набор помещаемых файлов.
Значение по умолчанию: Истина.

<УникальныйИдентификаторФормы> (необязательный)

Тип: УникальныйИдентификатор.
Уникальный идентификатор формы, который можно получить с помощью свойства УникальныйИдентификатор формы клиентского приложения.
Файл помещается во временное хранилище и автоматически удаляется после удаления объекта формы.
Если параметр не указан, помещенное значение будет удалено, после очередного запроса сервера из общего модуля, при контекстном и неконтекстном серверном вызове из формы, при серверном вызове из модуля команды или при получении формы.

<ОписаниеОповещенияПередНачаломПомещенияФайлов> (необязательный)

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

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

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

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

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

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

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

Описание:

Начинает помещение набора файлов из локальной файловой системы во временное хранилище.

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

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

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

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

Не рекомендуется использовать, начиная с версии 8.3.15.

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

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