Windows Script Host — объект WshShell

1. Создание объекта

Пример:

Set WshShell = CreateObject(«WScript.Shell»)

2. Свойства

2.1. CurrentDirectory

Синтаксис: CurrentDirectory

Возвращаемое значение: строка, путь к текущему каталогу.

Замечание: чтение и запись.

Пример:

Set WshShell = CreateObject(«WScript.Shell») MsgBox WshShell.CurrentDirectory

2.2. Environment

Синтаксис: Environment( )

Возвращаемое значение: объект-коллекция «WshEnvironment», содержащая переменные среды. Необязательный параметр «Type» — строка, задаёт вид переменных.

Возможные значения:

• «System» — переменные среды операционной системы (в Windows NT/2000 — это параметр по умолчанию).
• «User» — переменные среды пользователя.
• «Volatile» — временные переменные.
• «Process» — переменные среды текущего командного окна (в Windows 95/98/Me — это единственно возможный параметр).

Замечание: чтение и запись. В коллекцию можно добавлять элементы и удалять их.

Пример:

Set WshShell = CreateObject(«WScript.Shell») Set WshEnv = WshShell.Environment MsgBox WshEnv.Item(«WINDIR»)

Другой Пример:

Set WshShell = CreateObject(«WScript.Shell») WScript.Echo «ПЕРЕМЕННЫЕ System:» For Each Var In WshShell.Environment(«System») WScript.Echo Var Next WScript.Echo vbCrLf & «ПЕРЕМЕННЫЕ User:» For Each Var In WshShell.Environment(«User») WScript.Echo Var Next WScript.Echo vbCrLf & «ПЕРЕМЕННЫЕ Volatile:» For Each Var In WshShell.Environment(«Volatile») WScript.Echo Var Next WScript.Echo vbCrLf & «ПЕРЕМЕННЫЕ Process:» For Each Var In WshShell.Environment(«Process») WScript.Echo Var Next

2.3. SpecialFolders

Синтаксис: SpecialFolders( )

Возвращаемое значение: объект-коллекция «SpecialFolders», содержащая пути к специальным папкам Windows. Некоторые специальные папки:

• AllUsersDesktop
• AllUsersStartMenu
• AllUsersPrograms
• AllUsersStartup
• Desktop
• Favorites
• Fonts
• MyDocuments
• NetHood
• PrintHood
• Programs
• Recent
• SendTo
• StartMenu
• Startup
• Template

Замечание: только чтение.

Пример:

Set WshShell = CreateObject(«WScript.Shell») Set SpecialFolders = WshShell.SpecialFolders MsgBox SpecialFolders.Item(«Desktop») MsgBox WshShell.SpecialFolders(«Desktop»)

Другой Пример:

Set WshShell = CreateObject(«WScript.Shell») For Each Folder In WshShell.SpecialFolders WScript.Echo Folder Next

3. Методы

3.1. ExpandEnvironmentStrings

Синтаксис: ExpandEnvironmentStrings( )

Назначение: возвращает значение переменной среды текущего командного окна.

Параметры: — строка, имя переменной. Должно быть окружено знаками «%».

Пример:

Set WshShell = CreateObject(«WScript.Shell») MsgBox WshShell.ExpandEnvironmentStrings(«%WinDir%»)

3.2. Popup

Синтаксис: Popup(

Назначение: выводит на экран модальное окно сообщения.

Параметры:

— строка, текст сообщения.

— необязательный, число. Количество секунд, по истечении которого окно будет автоматически закрыто.

— необязательный, строка. Текст заголовка окна сообщения.

— необязательный, число. Комбинация флагов, определяет тип кнопок и значка. Возможные значения флагов:

• 0 — кнопка ОК.
• 1 — кнопки ОК и Отмена.
• 2 — кнопки Стоп, Повтор, Пропустить.
• 3 — кнопки Да, Нет, Отмена.
• 4 — кнопки Да и Нет.
• 5 — кнопки Повтор и Отмена.
• 16 — значок Stop.
• 32 — значок Question.
• 48 — значок Exclamation.
• 64 — значок Information.

Описание: возвращает целое значение, с помощью которого можно узнать, какая кнопка быля нажата пользователем.

Возможные значения:

• -1 — таймаут.
• 1 — кнопка ОК.
• 2 — кнопка Отмена.
• 3 — кнопка Стоп.
• 4 — кнопка Повтор.
• 5 — кнопка Пропустить.
• 6 — кнопка Да.
• 7 — кнопка Нет.

Пример:

Set WshShell = CreateObject(«WScript.Shell») WshShell.Popup «Текст сообщения»,, «Текст заголовка», 4+16

3.3. SendKeys

Синтаксис: SendKeys( )

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

Параметры: — строка, перечень клавиш в специальном формате.

Описание: каждая клавиша задаётся своим символом. Например, чтобы задать нажатие друг за другом клавиш А, Б и В, нужно указать в качестве параметра строку «АБВ». Некоторые специальные символы следует всегда задавать заключёнными в фигурные скобки. Перечень таких символов:

Задание неотображаемых символов и специальных клавиш:

Объект WshShell

1. Создание объекта

2. Свойства

2.1. CurrentDirectory

Возвращаемое значение: строка, путь к текущему каталогу.

Замечание: чтение и запись.

2.2. Environment

Возвращаемое значение: объект-коллекция «WshEnvironment», содержащая переменные среды. Необязательный параметр «Type» — строка, задаёт вид переменных. Возможные значения:

• «System» — переменные среды операционной системы (в Windows NT/2000 — это параметр по умолчанию).
• «User» — переменные среды пользователя.
• «Volatile» — временные переменные.
• «Process» — переменные среды текущего командного окна (в Windows 95/98/Me — это единственно возможный параметр).

Замечание: чтение и запись. В коллекцию можно добавлять элементы и удалять их.

2.3. SpecialFolders

Возвращаемое значение: объект-коллекция «SpecialFolders», содержащая пути к специальным папкам Windows. Некоторые специальные папки:

• AllUsersDesktop
• AllUsersStartMenu
• AllUsersPrograms
• AllUsersStartup
• Desktop
• Favorites
• Fonts
• MyDocuments
• NetHood
• PrintHood
• Programs
• Recent
• SendTo
• StartMenu
• Startup
• Template

Замечание: только чтение.

3. Методы

3.1. ExpandEnvironmentStrings

Назначение: возвращает значение переменной среды текущего командного окна.

• — строка, имя переменной. Должно быть окружено знаками «%».

3.2. Popup

Назначение: выводит на экран модальное окно сообщения.

— строка, текст сообщения.

— необязательный, число. Количество секунд, по истечении которого окно будет автоматически закрыто.

— необязательный, строка. Текст заголовка окна сообщения.

— необязательный, число. Комбинация флагов, определяет тип кнопок и значка. Возможные значения флагов:

• 0 — кнопка ОК.
• 1 — кнопки ОК и Отмена.
• 2 — кнопки Стоп, Повтор, Пропустить.
• 3 — кнопки Да, Нет, Отмена.
• 4 — кнопки Да и Нет.
• 5 — кнопки Повтор и Отмена.
• 16 — значок Stop.
• 32 — значок Question.
• 48 — значок Exclamation.
• 64 — значок Information.

Описание: возвращает целое значение, с помощью которого можно узнать, какая кнопка быля нажата пользователем. Возможные значения:

• -1 — таймаут.
• 1 — кнопка ОК.
• 2 — кнопка Отмена.
• 3 — кнопка Стоп.
• 4 — кнопка Повтор.
• 5 — кнопка Пропустить.
• 6 — кнопка Да.
• 7 — кнопка Нет.

3.3. SendKeys

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

• — строка, перечень клавиш в специальном формате.

Описание: каждая клавиша задаётся своим символом. Например, чтобы задать нажатие друг за другом клавиш А, Б и В, нужно указать в качестве параметра строку «АБВ». Некоторые специальные символы следует всегда задавать заключёнными в фигурные скобки. Перечень таких символов:

Задание неотображаемых символов и специальных клавиш:

Можно использовать скобки. Например, нажатие клавиш и при нажатом следует записывать как «+(GS)». Запись «+GS» приведёт к нажатию клавиши при нажатом , а затем клавиши уже без .

Задание нескольких нажатий: «» приведёт к нажатию клавиши 42 раза подряд, «» приведёт к нажатию клавиши 10 раз подряд.

Метод не может быть использован для посылки нажатий клавиш в приложения MS-DOS.

3.4. Run

Назначение: создаёт новый независимый процесс, который запускает заданное приложение.

• — строка, командная строка запуска приложения.
• — необязательный, число. Определяет вид окна запускаемого приложения. Некоторые возможные значения:
  • 0 — Не отображает окно.
  • 1 — Активизирует и отображает окно.
  • 2 — Активизирует окно и отображает его в свёрнутом виде.
  • 3 — Активизирует окно и отображает его в максимизированном виде.

• — необязательный, булево (число). True — сценарий возобновит работу только после завершения вызванного процесса. False (по умолчанию) — управление передаётся сразу обратно в сценарий.

Описание: если параметр «WaitOnReturn» установлен в True, метод возвращает код выхода вызванного приложения. Иначе метод всегда возвращает ноль.

3.5. Exec

Назначение: создаёт новый дочерний процесс (т.е. процесс с теми же переменными среды), который запускает заданное консольное приложение. Возвращается объект «WshScriptExec», который позволяет контролировать ход выполнения запущенного приложения и обеспечивает доступ к потокам StdIn, StdOut и StdErr этого приложения.

• — строка, командная строка запуска приложения.

Описание: с помощью данного метода можно запускать и графические оконные приложения. В этом случае возвращаемый объект «WshScriptExec» полезен тем, что позволяет получить идентификатор запущенного процесса, который можно использовать, например, для активизации приложения с помощью метода AppActivate.

3.6. AppActivate

Назначение: активизирует указанное окно какого-либо приложения. Возвращает True в случае успеха и False в случае неудачи.

• — заголовок окна приложения или идентификатор процесса.

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

3.7. RegDelete

Назначение: удаляет из реестра заданный параметр или раздел целиком.

• — строка, наименование параметра или раздела.

Описание: если «Name» оканчивается символом «\», метод удаляет ключ целиком, в противном случае удаляется параметр. Параметр «Name» должен начинаться с одного из корневых ключей:

• HKEY_CURRENT_USER — HKCU
• HKEY_LOCAL_MACHINE — HKLM
• HKEY_CLASSES_ROOT — HKCR
• HKEY_USERS — HKEY_USERS
• HKEY_CURRENT_CONFIG — HKEY_CURRENT_CONFIG

3.8. RegRead

Назначение: читает из реестра заданный параметр или значение по умолчанию для раздела.

• — строка, наименование параметра или раздела.

Описание: если «Name» оканчивается символом «\», метод считывает значение по умолчанию для раздела, в противном случае считывается параметр. Параметр «Name» должен начинаться с одного из корневых ключей:

• HKEY_CURRENT_USER — HKCU
• HKEY_LOCAL_MACHINE — HKLM
• HKEY_CLASSES_ROOT — HKCR
• HKEY_USERS — HKEY_USERS
• HKEY_CURRENT_CONFIG — HKEY_CURRENT_CONFIG

3.9. RegWrite

Назначение: записываает в реестр заданный параметр или раздел.

• — строка, наименование параметра или раздела.
• — значение параметра или значение для раздела по умолчанию.
• — необязательный, тип значения. Возможные значения: «REG_SZ», «REG_EXPAND_SZ», «REG_DWORD», «REG_BINARY». Если указано «REG_SZ» или «REG_EXPAND_SZ», параметр «Type» конвертируется в строку, если указано «REG_DWORD», параметр «Type» конвертируется в целое число, если указано «REG_BINARY», параметр «Type» должен быть целым числом.

Описание: если «Name» оканчивается символом «\», метод записывает раздел, в противном случае записывается параметр. Параметр «Name» должен начинаться с одного из корневых ключей:

• HKEY_CURRENT_USER — HKCU
• HKEY_LOCAL_MACHINE — HKLM
• HKEY_CLASSES_ROOT — HKCR
• HKEY_USERS — HKEY_USERS
• HKEY_CURRENT_CONFIG — HKEY_CURRENT_CONFIG

3.10. LogEvent

Назначение: протоколирует событие в журнале WindowsNT или в файле WSH.log. Возвращает True в случае успеха и False в противном случае.

• — число, тип сообщения. Возможные значения:
  • 0 — SUCCESS
  • 1 — ERROR
  • 2 — WARNING
  • 4 — INFORMATION
  • 8 — AUDIT_SUCCESS
  • 16 — AUDIT_FAILURE

• — строка, текст сообщения.
• — строка, название системы, в которой протоколируется событие (по умолчанию — локальная система), может задаваться только в Windows NT/2000/XP.

Описание: в Windows NT/200/XP события записываются в системном журнале, а в Windows 9x — в файле WSH.log, который находится в каталоге пользователей.

3.11. CreateShortcut

Назначение: возвращает объект «WshShortcut» или «WshURLShortcut», указывающий на ярлык .lnk или .url.

— строка, полный путь к создаваемому или изменяемому файлу ярлыка.

4. Объект WshScriptExec

4.1. Создание объекта

4.2. Свойства

4.2.1. ExitCode

Возвращаемое значение: код выхода, устанавливаемый дочерней задачей при завершении выполнения.

Замечание: только чтение.

4.2.2. ProcessID

Возвращаемое значение: идентификатор запущенного процесса (PID).

Замечание: только чтение.

4.2.3. Status

Возвращаемое значение: состояние запущенного процесса. Возможные значения:

• 0 — приложение запущено.
• 1 — приложение завершено.

Замечание: только чтение.

4.2.4. StdOut

Возвращаемое значение: объект «TextStream», соответствующий стандартному выходному потоку запущенной задачи.

Замечание: только чтение.

4.2.5. StdIn

Возвращаемое значение: объект «TextStream», соответствующий стандартному входному потоку запущенной задачи.

Замечание: только чтение.

4.2.6. StdErr

Возвращаемое значение: объект «TextStream», соответствующий стандартному потоку ошибок запущенной задачи.

Замечание: только чтение.

4.3. Методы

4.3.1. Terminate

Назначение: пытается закрыть приложение, посылая ему сообщение WM_CLOSE. Если это не срабатывает, задача завершается принудительно.

5. Объект WshShortcut

5.1. Создание объекта

5.2. Свойства

5.2.1. Arguments

Возвращаемое значение: строка, параметры командной строки программы, запускаемой ярлыком.

Замечание: чтение и запись.

5.2.2. Description

Возвращаемое значение: строка, описание в поле «Комментарий» («Comment») в свойствах ярлыка.

Замечание: чтение и запись.

5.2.3. FullName

Возвращаемое значение: строка, полный путь к файлу ярлыка.

Замечание: только чтение.

5.2.4. Hotkey

Возвращаемое значение: строка, содержащая названия горячих клавиш, разделённые знаком «+».

Замечание: чтение и запись.

5.2.5. IconLocation

Возвращаемое значение: строка, содержащая расположение иконки для ярлыка в формате «путь к файлу, индекс иконки». Индексы иконок начинаются с нуля.

Замечание: чтение и запись.

5.2.6. TargetPath

Возвращаемое значение: строка, содержащая путь к исполняемому файлу.

Замечание: чтение и запись.

5.2.7. WindowStyle

Возвращаемое значение: число, определяющее вид окна запускаемого приложения. Возможные значения:

• 1 — Стандартное окно.
• 3 — Максимизированное окно.
• 7 — Минимизированное окно.

Замечание: чтение и запись.

5.2.8. WorkingDirectory

Возвращаемое значение: строка, путь к рабочему каталогу ярлыка.