Глобальный контекст.НачатьПомещениеФайловНаСервер (Global context.BeginPutFilesToServer)
Глобальный контекст (Global context)
НачатьПомещениеФайловНаСервер (BeginPutFilesToServer)
Доступен, начиная с версии 8.3.15.
Вариант синтаксиса: По описанию передаваемых файлов
Синтаксис:
НачатьПомещениеФайловНаСервер(<ОписаниеОповещенияОЗавершении>, <ОписаниеОповещенияОХодеВыполнения>, <ОписаниеОповещенияПередНачалом>, <ОписанияПередаваемыхФайлов>, <УникальныйИдентификаторФормы>)Параметры:
<ОписаниеОповещенияОЗавершении> (необязательный)
Содержит описание процедуры, которая будет вызвана в случае успешного помещения файлов, а так же процедуры, которая будет в случае возникновения ошибки.
Если хотя бы один из передаваемых файлов не будет найден на диске, то будет сгенерировано исключение.
После успешного завершения помещения файла процедура, заданная в параметре <ОписаниеОповещенияОЗавершении>, будет вызвана со следующими параметрами:
- <ПомещенныеФайлы> - тип: Массив, Неопределено. Массив объектов типа ОписаниеПомещенногоФайла, либо Неопределено, если помещение файлов было отменено.
- <ДополнительныеПараметры> - значение, которое было указано при создании объекта ОписаниеОповещения.
<ОписаниеОповещенияОХодеВыполнения> (необязательный)
Содержит описание процедуры, которая будет вызвана несколько раз по мере помещения файлов. Количество раз и время вызова не определено строго. Оповещение будет вызвано со следующими параметрами:
- <ПомещаемыйФайл> - тип: СсылкаНаФайл. Ссылка на файл, помещаемый во временное хранилище.
- <Помещено> - тип: Число. Процент помещенной части текущего файла.
- <ОтказОтПомещенияФайла> - тип: Булево. Признак отказа от дальнейшего помещения файла. Если в теле процедуры-обработчика установить данному параметру значение Истина, то помещение файла будет отменено. Значение по умолчанию: Ложь. Возвращаемый параметр.
- <ПомещеноВсего> - тип: Число. Процент помещенной части всех файлов.
- <ОтказОтПомещенияВсехФайлов> - тип: Булево. Признак отказа от дальнейшего помещения всех файлов. Если в теле процедуры-обработчика установить данному параметру значение Истина, то помещение всех файлов будет отменено. Значение по умолчанию: Ложь. Возвращаемый параметр.
- <ДополнительныеПараметры> - Значение, которое было указано при создании объекта ОписаниеОповещения.
<ОписаниеОповещенияПередНачалом> (необязательный)
Содержит описание процедуры, которая будет вызвана непосредственно перед началом помещения файлов во временное хранилище. Оповещение будет вызвано со следующими параметрами:
- <ПомещаемыеФайлы> - тип: Массив. Массив элементов типа СсылкаНаФайл, готовых к помещению во временное хранилище.
- <ОтказОтПомещенияВсехФайлов> - тип: Булево. Признак отказа от дальнейшего помещения всех файлов. Если в теле процедуры-обработчика установить данному параметру значение Истина, то помещение всех файлов будет отменено (в этом случае никакие другие оповещения вызваны не будут). Значение по умолчанию: Ложь. Возвращаемый параметр.
- <ДополнительныеПараметры> - Значение, которое было указано при создании объекта ОписаниеОповещения.
<ОписанияПередаваемыхФайлов> (обязательный)
Массив объектов типа ОписаниеПередаваемогоФайла. Каждый элемент массива должен содержать непустой путь к файлу на диске. Адрес временного хранилища, куда должен быть помещен файл, может быть не задан – в таком случае будет создан новый файл.
<УникальныйИдентификаторФормы> (необязательный)
Уникальный идентификатор формы, который можно получить с помощью свойства УникальныйИдентификатор формы клиентского приложения.
Файл помещается во временное хранилище и автоматически удаляется после удаления объекта формы.
Если параметр не указан, помещенное значение будет удалено после очередного запроса сервера из общего модуля, при контекстном и неконтекстном серверном вызове из формы, при серверном вызове из модуля команды или при получении формы.
Описание варианта метода:
Начинает помещение файлов, заданных путями на диске, из локальной файловой системы во временное хранилище.В веб-клиенте необходимо расширение работы с файлами.
Обработчик <ОписаниеОповещенияОХодеВыполнения> в веб-клиенте будет вызван только дважды: когда общее количество помещенных во временное хранилище байт равно 0 и полному размеру помещаемых файлов.
Вариант синтаксиса: По строке поиска
Синтаксис:
НачатьПомещениеФайловНаСервер(<ОписаниеОповещенияОЗавершении>, <ОписаниеОповещенияОХодеВыполнения>, <ОписаниеОповещенияПередНачалом>, <СтрокаПоиска>, <УникальныйИдентификаторФормы>)Параметры:
<ОписаниеОповещенияОЗавершении> (необязательный)
Содержит описание процедуры, которая будет вызвана в случае успешного помещения файлов, а так же процедуры, которая будет в случае возникновения ошибки.
Если хотя бы один из передаваемых файлов не будет найден на диске, то будет сгенерировано исключение.
После успешного завершения помещения файла процедура, заданная в параметре <ОписаниеОповещенияОЗавершении>, будет вызвана со следующими параметрами:
- <ПомещенныеФайлы> - тип: Массив, Неопределено. Массив объектов типа ОписаниеПомещенногоФайла, либо Неопределено, если помещение файлов было отменено.
- <ДополнительныеПараметры> - значение, которое было указано при создании объекта ОписаниеОповещения.
<ОписаниеОповещенияОХодеВыполнения> (необязательный)
Содержит описание процедуры, которая будет вызвана несколько раз по мере помещения файлов. Количество раз и время вызова не определено строго. Оповещение будет вызвано со следующими параметрами:
- <ПомещаемыйФайл> - тип: СсылкаНаФайл. Ссылка на файл, помещаемый во временное хранилище.
- <Помещено> - тип: Число. Процент помещенной части текущего файла.
- <ОтказОтПомещенияФайла> - тип: Булево. Признак отказа от дальнейшего помещения файла. Если в теле процедуры-обработчика установить данному параметру значение Истина, то помещение файла будет отменено. Значение по умолчанию: Ложь. Возвращаемый параметр.
- <ПомещеноВсего> - тип: Число. Процент помещенной части всех файлов.
- <ОтказОтПомещенияВсехФайлов> - тип: Булево. Признак отказа от дальнейшего помещения всех файлов. Если в теле процедуры-обработчика установить данному параметру значение Истина, то помещение всех файлов будет отменено. Значение по умолчанию: Ложь. Возвращаемый параметр.
- <ДополнительныеПараметры> - Значение, которое было указано при создании объекта ОписаниеОповещения.
<ОписаниеОповещенияПередНачалом> (необязательный)
Содержит описание процедуры, которая будет вызвана непосредственно перед началом помещения файлов во временное хранилище. Оповещение будет вызвано со следующими параметрами:
- <ПомещаемыеФайлы> - тип: Массив. Массив элементов типа СсылкаНаФайл, готовых к помещению во временное хранилище.
- <ОтказОтПомещенияВсехФайлов> - тип: Булево. Признак отказа от дальнейшего помещения всех файлов. Если в теле процедуры-обработчика установить данному параметру значение Истина, то помещение всех файлов будет отменено (в этом случае никакие другие оповещения вызваны не будут). Значение по умолчанию: Ложь. Возвращаемый параметр.
- <ДополнительныеПараметры> - Значение, которое было указано при создании объекта ОписаниеОповещения.
<СтрокаПоиска> (обязательный)
Строка должна иметь вид пути к каталогу, в котором производится поиск. Каталог может быть как на локальной сети, так и на ftp-сервере. При использовании этой схемы в адресах необходимо указывать прямые слеши '/', а не обратные '\'.
Допускается указание полного имени файла (путь + имя).
<УникальныйИдентификаторФормы> (необязательный)
Уникальный идентификатор формы, который можно получить с помощью свойства УникальныйИдентификатор формы клиентского приложения.
Файл помещается во временное хранилище и автоматически удаляется после удаления объекта формы клиентского приложения.
Если параметр не указан, помещенное значение будет удалено после очередного запроса сервера из общего модуля, при контекстном и неконтекстном серверном вызове из формы, при серверном вызове из модуля команды или при получении формы.
Описание варианта метода:
Начинает помещение файлов, найденных по строке поиска, из локальной файловой системы во временное хранилище.В веб-клиенте необходимо расширение работы с файлами.
Обработчик <ОписаниеОповещенияОХодеВыполнения> в веб-клиенте вызовется только дважды: когда общее количество помещенных во временное хранилище байт равно 0 и полному размеру помещаемых файлов.
Вариант синтаксиса: По ссылкам на файлы
Синтаксис:
НачатьПомещениеФайловНаСервер(<ОписаниеОповещенияОЗавершении>, <ОписаниеОповещенияОХодеВыполнения>, <ОписаниеОповещенияПередНачалом>, <СсылкиНаФайлы>, <УникальныйИдентификаторФормы>)Параметры:
<ОписаниеОповещенияОЗавершении> (необязательный)
Содержит описание процедуры, которая будет вызвана в случае успешного помещения файлов, а так же процедуры, которая будет в случае возникновения ошибки.
Если хотя бы один из передаваемых файлов не будет найден на диске, то возникнет исключение.
После успешного завершения помещения файла процедура, заданная в параметре <ОписаниеОповещенияОЗавершении>, будет вызвана со следующими параметрами:
- <ПомещенныеФайлы> - тип: Массив, Неопределено. Массив объектов типа ОписаниеПомещенногоФайла, либо Неопределено, если помещение файлов было отменено.
- <ДополнительныеПараметры> - Значение, которое было указано при создании объекта ОписаниеОповещения.
<ОписаниеОповещенияОХодеВыполнения> (необязательный)
Содержит описание процедуры, которая будет вызвана несколько раз по мере помещения файлов. Количество раз и время вызова не определено строго. Оповещение будет вызвано со следующими параметрами:
- <ПомещаемыйФайл> - тип: СсылкаНаФайл. Ссылка на файл, помещаемый во временное хранилище.
- <Помещено> - тип: Число. Процент помещенной части текущего файла.
- <ОтказОтПомещенияФайла> - тип: Булево. Признак отказа от дальнейшего помещения файла. Если в теле процедуры-обработчика установить данному параметру значение Истина, то помещение файла будет отменено. Значение по умолчанию: Ложь. Возвращаемый параметр.
- <ПомещеноВсего> - тип: Число. Процент помещенной части всех файлов.
- <ОтказОтПомещенияВсехФайлов> - тип: Булево. Признак отказа от дальнейшего помещения всех файлов. Если в теле процедуры-обработчика установить данному параметру значение Истина, то помещение всех файлов будет отменено. Значение по умолчанию: Ложь. Возвращаемый параметр.
- <ДополнительныеПараметры> - Значение, которое было указано при создании объекта ОписаниеОповещения.
<ОписаниеОповещенияПередНачалом> (необязательный)
Содержит описание процедуры, которая будет вызвана непосредственно перед началом помещения файлов во временное хранилище. Оповещение будет вызвано со следующими параметрами:
- <ПомещаемыеФайлы> - тип: Массив. Массив элементов типа СсылкаНаФайл, готовых к помещению во временное хранилище.
- <ОтказОтПомещенияВсехФайлов> - тип: Булево. Признак отказа от дальнейшего помещения всех файлов. Если в теле процедуры-обработчика установить данному параметру значение Истина, то помещение всех файлов будет отменено (в этом случае никакие другие оповещения вызваны не будут). Значение по умолчанию: Ложь. Возвращаемый параметр.
- <ДополнительныеПараметры> - Значение, которое было указано при создании объекта ОписаниеОповещения.
<СсылкиНаФайлы> (обязательный)
Содержит массив объектов типа СсылкаНаФайл.
<УникальныйИдентификаторФормы> (необязательный)
Уникальный идентификатор формы, который можно получить с помощью свойства УникальныйИдентификатор формы клиентского приложения.
Файл помещается во временное хранилище и автоматически удаляется после удаления объекта формы.
Если параметр не указан, помещенное значение будет удалено после очередного запроса сервера из общего модуля, при контекстном и неконтекстном серверном вызове из формы, при серверном вызове из модуля команды или при получении формы.
Описание варианта метода:
Начинает помещение файлов, заданных ссылками на файл, из локальной файловой системы во временное хранилище.В веб-клиенте расширение работы с файлами не требуется.
Вариант синтаксиса: С диалогом выбора файлов
Синтаксис:
НачатьПомещениеФайловНаСервер(<ОписаниеОповещенияОЗавершении>, <ОписаниеОповещенияОХодеВыполнения>, <ОписаниеОповещенияПередНачалом>, <ПараметрыДиалога>, <УникальныйИдентификаторФормы>)Параметры:
<ОписаниеОповещенияОЗавершении> (необязательный)
Задает процедуру, которая будет вызвана в случае успешного помещения файлов, а так же процедуры, которая будет в случае возникновения ошибки.
После успешного завершения помещения файла процедура, заданная в параметре <ОписаниеОповещенияОЗавершении>, будет вызвана со следующими параметрами:
- <ПомещенныеФайлы> - тип: Массив, Неопределено. Массив объектов типа ОписаниеПомещенногоФайла, либо Неопределено, если помещение файлов было отменено.
- <ДополнительныеПараметры> - Значение, которое было указано при создании объекта ОписаниеОповещения.
<ОписаниеОповещенияОХодеВыполнения> (необязательный)
Содержит описание процедуры, которая будет вызвана несколько раз по мере помещения файлов. Количество раз и время вызова не определено строго. Оповещение будет вызвано со следующими параметрами:
- <ПомещаемыйФайл> - тип: СсылкаНаФайл. Ссылка на файл, помещаемый во временное хранилище.
- <Помещено> - тип: Число. Процент помещенной части текущего файла.
- <ОтказОтПомещенияФайла> - тип: Булево. Признак отказа от дальнейшего помещения файла. Если в теле процедуры-обработчика установить данному параметру значение Истина, то помещение файла будет отменено. Значение по умолчанию: Ложь. Возвращаемый параметр.
- <ПомещеноВсего> - тип: Число. Процент помещенной части всех файлов.
- <ОтказОтПомещенияВсехФайлов> - тип: Булево. Признак отказа от дальнейшего помещения всех файлов. Если в теле процедуры-обработчика установить данному параметру значение Истина, то помещение всех файлов будет отменено. Значение по умолчанию: Ложь. Возвращаемый параметр.
- <ДополнительныеПараметры> - Значение, которое было указано при создании объекта ОписаниеОповещения.
<ОписаниеОповещенияПередНачалом> (необязательный)
Содержит описание процедуры, которая будет вызвана непосредственно перед началом помещения файлов во временное хранилище. Оповещение будет вызвано со следующими параметрами:
- <ПомещаемыеФайлы> - тип: Массив. Массив элементов типа СсылкаНаФайл, готовых к помещению во временное хранилище.
- <ОтказОтПомещенияВсехФайлов> - тип: Булево. Признак отказа от дальнейшего помещения всех файлов. Если в теле процедуры-обработчика установить данному параметру значение Истина, то помещение всех файлов будет отменено (в этом случае никакие другие оповещения вызваны не будут). Значение по умолчанию: Ложь. Возвращаемый параметр.
- <ДополнительныеПараметры> - Значение, которое было указано при создании объекта ОписаниеОповещения.
<ПараметрыДиалога> (необязательный)
Структура, содержащая параметры диалога, который будет показан пользователю.
<УникальныйИдентификаторФормы> (необязательный)
Уникальный идентификатор формы, который можно получить с помощью свойства УникальныйИдентификатор формы клиентского приложения.
Файл помещается во временное хранилище и автоматически удаляется после удаления объекта формы.
Если параметр не указан, помещенное значение будет удалено, после очередного запроса сервера из общего модуля, при контекстном и неконтекстном серверном вызове из формы, при серверном вызове из модуля команды или при получении формы.
Описание варианта метода:
Начинает помещение файлов, показывая диалог выбора файлов из локальной файловой системы во временное хранилище.В веб-клиенте расширение работы с файлами не требуется.
Описание:
Начинает помещение файлов во временное хранилище.
Доступность:
Тонкий клиент, веб-клиент, мобильный клиент, толстый клиент, мобильное приложение (клиент), мобильное приложение (сервер), мобильный автономный сервер.
Примечание:
В веб-клиенте в случае работы метода через расширение работы с файлами обработчик <ОписаниеОповещенияОХодеВыполнения> вызовется только дважды: когда общее количество помещенных во временное хранилище байт равно 0 и когда оно равно полному размеру помещаемых файлов.После вызова данного метода допускается вызов аналогичного метода без ожидания выполнения предыдущего.
Использование в версии:
Доступен, начиная с версии 8.3.15.