Глобальный контекст.ПолучитьФайл (Global context.GetFile)

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

ПолучитьФайл (GetFile)

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

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

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

Синтаксис:

ПолучитьФайл(<Адрес>, <ИмяФайла>, <Интерактивно>)

Параметры:

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

Тип: Строка.
Расположение данных во временном хранилище или в информационной базе.

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

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

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

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

Возвращаемое значение:

Тип: Булево, Неопределено.
Ложь - пользователь отменил операцию сохранения файлов (в интерактивном режиме).
В режиме запуска "Веб-клиент" всегда возвращает Неопределено.

Описание:

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

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

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

Примечание:

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

См. также:

Глобальный контекст, метод ПолучитьФайлССервераАсинх
Глобальный контекст, метод ПолучитьФайлыССервераАсинх
Глобальный контекст, метод ПолучитьФайлы

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

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

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

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


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