Руководство разработчика

Опции экспорта

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

Опции разделяются символом ">". Первым всегда идет имя файла для сохранения. Прочие опции указываются в виде просто имени или в формате <имя>=<значение>. Порядок указания опций, кроме первой (файла для сохранения), роли не играет. Регистр символов в именах опций роли не играет.

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

Опция CLOSE позволяет закрыть офисное приложение после сохранения результата экспорта файл. Эта опция учитывается только в том случае, когда задан файла для сохранения.

Опция ADD дает возможность добавлять лист в сохраняемый файл после подстановок в шаблон. Эта возможность поддерживается только для экспорта в MS Excel и OpenOffice Calc. Дополнительно может быть указано имя нового листа: ADD=<имя_листа>. Если файл с указанным именем для сохранения результата уже существует, то он открывается и лист добавляется к существующим, иначе создается новый документ с одним листом. Опция ADD может комбинироваться с директивой CLOSE. Эта опция учитывается только в том случае, когда задан файла для сохранения.

Опция LOG позволяет включить вывод диагностической информации в log-файл. Дополнительно может быть указано имя log-файла: LOG=<файл>. Когда указано только имя файла или относительный путь, то log-файл записывается в рабочую папку. Эта опция доступна для всех приложений, задач и комбинаций других опций.

Примеры

Сохранение результатов экспорта в указанный файл в рабочей папке:

"MyCharts\Chart_1.ods"

Сохранение результатов экспорта в указанный файл по абсолютному пути и закрытие офисного приложения:

"d:\export\saved.docx>close"

Сохранение результатов экспорта в указанный файл в по абсолютному пути с добавлением нового листа (имя назначается автоматически офисным приложением: "Лист3", например) и закрытие офисного приложения:

"d:\output\export.ods>ADD>CLOSE"

Сохранение результатов экспорта в указанный файл в рабочей папке с добавлением нового листа "Документ2" и закрытие офисного приложения:

"output.xls>CLOSE>ADD=Документ2"

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

"d:\export\text.odt>close>log"

Без сохранения в файл, вывод диагностики в log-файл по абсолютному пути:

"NUL>LOG=D:\Export\Log\my.log"

См. также: