Андрей Попов - Windows Script Host для Windows 2000/XP

При запуске почти всех стандартных команд или утилит командной строки Windows с ключом /?на экран выводится встроенная справка, в которой кратко описываются назначение и синтаксис этой команды или утилиты (рис. 3.1).

Рис. 3.1.Встроенная справка для команды COPY

Хорошим тоном считается создание такой справки и для разрабатываемых сценариев WSH. Понятно, что добавление в сценарий функции вывода информации о назначении, синтаксисе и аргументах этого сценария потребовало бы написания довольно большого количества кода: необходимо следить за ключом /?в командной строке, а при добавлении нового параметра командной строки возникнет необходимость изменения функции, отвечающей за вывод информации на экран.

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

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

Элемент является дочерним относительно , поэтому все описания, приведенные внутри , относятся только к текущему заданию.

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

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

Информация, которая указывается для объявляемого в элементе параметра командной строки, используется только для самодокументируемости сценария и никак не влияет на реальные значения, которые будут указаны в командной строке при запуске сценария. Например, если параметр объявлен как обязательный ( required="true"), но в действительности не был указан при запуске сценария, то никакой ошибки во время работы не произойдет.

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

/Имя:"Андрей Попов" /Возраст:30

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

/Имя /Возраст

Для того чтобы передать в сценарий аргумент командной строки типа "boolean", нужно после имени этого аргумента указать символ " +" (соответствует логическому значению "истина") или " -" (соответствует значению "ложь"). Например:

/Запись+ /ReWrite-

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

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

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

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

После запуска с помощью wscript.exe в сценарии named.wsf сначала вызывается метод WScript.Arguments.Usage, в результате чего на экран выводится диалоговое окно с информацией о сценарии и параметрах командной строки (рис. 3.2).

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

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

//Создаем объект WshNamed — коллекция именных аргументов сценария

objNamedArgs= WScript.Arguments.Named;

s="";

//Проверяем, существует ли аргумент /Имя:

if (objNamedArgs.Exists("Имя"))

//Получаем значение символьного аргумента /Имя

s+="Имя: "+objNamedArgs("Имя") +"\n";

//Проверяем, существует ли аргумент /Компьютер:

if (objNamedArgs.Exists("Компьютер"))

//Получаем значение символьного аргумента /Компьютер

s+="Машина: "+objNamedArgs("Компьютер") + "\n";

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

//Проверяем, существует ли аргумент /Новый

if (objNamedArgs.Exists("Новый"))

//Получаем с помощью условного оператора значение

//логического аргумента /Новый

s+="Новый пользователь: "+(objNamedArgs("Новый") ? "Да" : "Нет");

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

wscript.exe named.wsf /Имя:Popov /Компьютер:404_Popov /Новый+

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

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

Имя: named.wsf

Кодировка: Windows

name="Имя"

helpstring="Имя пользователя"

type="string" required="true"/>

name="Компьютер"

helpstring="Имя рабочей станции"

type="string" required="false"/>

name="Новый"

helpstring="Признак того, что такого пользователя раньше не было"

type="boolean" required="true"/>

var objNamedArgs,s;

s="";

//Вызываем метод ShowUsage для вывода на экран описания сценария

WScript.Arguments.ShowUsage();

//Создаем объект WshNamed - коллекция именных аргументов сценария