Чтение онлайн

Элемент

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

При этом сам элемент

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

Замечание

Элемент

<runtime>

является дочерним относительно

<job>

, поэтому все описания, приведенные внутри

<runtime>

, относятся только к текущему заданию.

С помощью элементов

можно описывать (документировать) именные параметры командной строки сценария. В табл. 3.1 приведено описание аргументов элемента .

Таблица 3.1. Аргументы элемента

Аргумент	Описание
name	Задает имя параметра командной строки
helpstring	Строка, содержащая описание параметра командной строки
type	Определяет тип параметра командной строки. Может принимать значения " string " (символьный тип), " boolean " (логический тип), " simple " (в сценарий передается только имя параметра без дополнительного значения). По умолчанию используется тип " simple "
required	Используется для того, чтобы показать, является ли параметр командной строки обязательным. Может принимать значения " true " (параметр нужно указывать обязательно) и " false " (параметр можно не указывать)

Информация, которая указывается для объявляемого в элементе

параметра командной строки, используется только для самодокументируемости сценария и никак не влияет на реальные значения, которые будут указаны в командной строке при запуске сценария. Например, если параметр объявлен как обязательный (), но в действительности не был указан при запуске сценария, то никакой ошибки во время работы не произойдет.

Если для аргумента командной строки сценария указан тип "

", то предполагается, что этот аргумент имеет имя и значение, разделенные символом "", например:

Если в качестве типа параметра командной строки используется "simple", то для этого параметра в командной строке указывается только его имя без значения:

Для того чтобы передать в сценарий аргумент командной строки типа "boolean", нужно после имени этого аргумента указать символ "

" (соответствует логическому значению "истина") или "" (соответствует значению "ложь"). Например:

В листинге 3.3 приведен сценарий named.wsf, в котором в блоке

описываются три именных аргумента командной строки:

(обязательный аргумент символьного типа);

(необязательный аргумент символьного типа);

(обязательный аргумент логического типа).

После запуска с помощью wscript.exe в сценарии named.wsf сначала вызывается метод

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

Рис. 3.2. Диалоговое окно с информацией о параметрах сценария named.wsf

Затем в сценарии проверяется, какие именно аргументы командной строки были подставлены при запуске, и выделяются значения этих аргументов. Для этого создается объект WshNamed, являющийся коллекцией именных аргументов командной строки, и используется метод Exists этого объекта:

Значением параметра

является константа логического типа ( или ), поэтому для формирования строки, соответствующей этому значению, используется условный оператор языка JScript:

Если запустить сценарий named.wsf следующим образом:

то на экран будет выведено диалоговое окно, показанное на рис. 3.3.

Рис. 3.3. Значения именных аргументов командной строки, переданных в named.wsf