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

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

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

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

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

НачатьПомещениеФайлаНаСервер

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

Синтаксис:

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

Параметры:

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

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

<Результат> - Ложь - в параметре <Интерактивно> установлен интерактивный режим (Истина) и пользователь отказался от выполнения операции в диалоге выбора файла,
<Адрес> - расположение нового файла,
<ПомещаемыйФайл> - Через этот параметр возвращается путь к файлу, указанный в диалоге выбора файла. Для неинтерактивного режима выбранное имя файла соответствует начальному имени файла. В веб-клиенте значение параметра зависит от типа браузера. Для Microsoft Internet Explorer возвращаемое значение зависит от настройки текущей зоны. Подробности: http://msdn.microsoft.com/en-us/library/ms535128(VS.85).aspx,
<ДополнительныеПараметры> - значение, которое было указано при создании объекта ОписаниеОповещения.

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

<Адрес> (необязательный)

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

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

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

в интерактивном режиме должен иметь тип ДиалогВыбораФайла,
в неинтерактивном режиме СсылкаНаФайл.

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

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

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

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

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

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

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

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

Описание:

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

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

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

Примечание:

На мобильной платформе параметр <Интерактивно> игнорируется и диалоговое окно выбора файла не отображается никогда.
В тонком и толстом клиентах данный метод, пока не сделан выбор из диалога (в интерактивном режиме), приостанавливает исполнение кода на встроенном языке. Само помещение файла не останавливает исполнение кода на встроенном языке.

Пример:

// Помещение файла с показом диалога.

&НаКлиенте
Процедура ПоместитьФайлИнтерактивно(Команда)
    ОбработкаОкончанияПомещения = Новый ОписаниеОповещения
        ("ОбработчикОкончанияПомещения", ЭтотОбъект);

    НачатьПомещениеФайла(ОбработкаОкончанияПомещения, , , Истина,
        ЭтотОбъект.УникальныйИдентификатор);
КонецПроцедуры

// Помещение файла без показа диалога.

// (должно быть подключено расширение работы с файлами)

&НаКлиенте
Процедура ПоместитьФайлНеИнтерактивно(Команда)
    ОбработкаОкончанияПомещения = Новый ОписаниеОповещения
        ("ОбработчикОкончанияПомещения", ЭтотОбъект);

    НачатьПомещениеФайла(ОбработкаОкончанияПомещения, ,
        "C:\Temp\test.txt", Ложь, ЭтотОбъект.УникальныйИдентификатор);
КонецПроцедуры

&НаКлиенте
Процедура ОбработчикОкончанияПомещения(Результат, Адрес,
        ВыбранноеИмяФайла, ДополнительныеПараметры) Экспорт
    Если Результат Тогда
        Сообщить(Адрес);
    Иначе
        Сообщить("Файл не был помещен.");
    КонецЕсли
КонецПроцедуры

См. также:

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

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

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

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

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