Элемент <description>

Элемент <description>

Внутри элемента <description> помещается текст (без дополнительных кавычек), описывающий назначение сценария. Как и все элементы внутри <runtime>, этот текст выводится на экран, если сценарий был запущен с ключом /? в командной строке или если в сценарии встретился вызов метода ShowUsage объекта WshArguments. При выводе текста на экран учитываются все имеющиеся в нем пробелы, символы табуляции и перевода строки.

Пример использования элемента <description> и метода ShowUsage представлен в сценарии descrip.wsf (листинг 3.5). Здесь сразу вызывается метод WScript.Arguments.ShowUsage, в результате чего на экран выводится диалоговое окно (в случае запуска сценария с помощью wscript.exe) (рис. 3.6, а) или просто строки текста (в случае запуска сценария с помощью cscript.exe) с описанием запущенного сценария (рис. 3.6, б).

Рис. 3.6. Вывод текста, описывающего сценарий: а — в графическом режиме; б — в консольном режиме 

Листинг 3.5. Файл descrip.wsf

<job id="Descrip">

 <runtime>

  <description>

  Имя: descrip.wsf

  Кодировка: Windows

  Описание: Здесь можно привести дополнительное описание сценария

  </description>

 </runtime>

 <script language="JScript">

 //Вызываем метод ShowUsage

 WScript.Arguments.ShowUsage();

 </script>

</job>