Ключи командной строки#

Многие программы IngortechSCADA поддерживают передачу данных с использованием ключей командной строки.

При запуске программы, в параметрах ее запуска, можно указать набор специальных параметров, которые будут использованы программой при ее работе.

Формат ключей командной строки#

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

Существует три способа передачи данных программе с использованием командной строки:

  1. Ключ со значением.

  2. Ключ без значения.

  3. Произвольные данные.

Предупреждение

  • Имя ключа должно быть указано с помощью символов латинского алфавита.

  • Имя может быть указано с использованием символов в верхнем или нижнем регистре, которые интерпретируются одинаково.

Ключ со значением

Формат

'-'|'/'<ИМЯ>=<ЗНАЧЕНИЕ>

Назначение

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

Описание ключа со значением обязано начинаться со специального символа '-' (минус) или '/' (обратная косая черта), после которого, без пробелов, указывается имя ключа.

Значение отделяется от имени ключа символом '=' (равно), после которого указывается текст значения ключа.

Если при описании ключа в программе используются угловые скобки (символы < и >), то это обозначает, что выделенная ими часть имени ключа может быть использована как короткая форма.

К примеру, ключ описанный в документации как -<V>alue=ЗНАЧЕНИЕ можно использовать как с указанием полного имени Value, так и короткого V. Т.е. команды -Value=ЗНАЧЕНИЕ и -V=ЗНАЧЕНИЕ будут эквивалентны и обозначать одно и то же.

Ключ без значения

Формат

'-'|'/'<ИМЯ>

Назначение

В отличие от «ключа со значением» ключ без значения не нуждается в указании какой-то информации. Данными для программы является сам факт наличия такого ключа. Такие ключи обычно используются для включения или отключения определенного функционала программ.

Описание ключа обязано начинаться с символа '-' (минус) или '/' (обратная косая черта), после которого, без пробелов, идет имя параметра, поддерживаемого программой.

Произвольные данные

Формат

ДАННЫЕ

Назначение

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

Произвольные данные в любом формате, передаваемые программе.