Run Method

Microsoft® Windows® Script Host
Run Method

Description

Creates a new process that executes strCommand.

Syntax

object.Run (strCommand, [intWindowStyle], [bWaitOnReturn])

Parameters

Part Description

object WshShell object.

strCommand Environment variables within the strCommand parameter are automatically expanded.

intWindowStyle Optional. Sets the window style of the program being run.

bWaitOnReturn Optional. If bWaitOnReturn is not specified or FALSE, immediately returns to script execution rather than waiting for the process to end.
If bWaitOnReturn is set to TRUE, the Run method returns any error code returned by the application.
If bWaitOnReturn is not specified or is FALSE, the Run method returns an error code of 0 (zero).

Remarks

The following table lists the available settings for intWindowStyle:

intWindowStyle Description

0 Hides the window and activates another window.

1 Activates and displays a window. If the window is minimized or maximized, the system restores it to its original size and position. An application should specify this flag when displaying the window for the first time.

2 Activates the window and displays it as a minimized window.

3 Activates the window and displays it as a maximized window.

4 Displays a window in its most recent size and position. The active window remains active.

5 Activates the window and displays it in its current size and position.

6 Minimizes the specified window and activates the next top-level window in the Z order.

7 Displays the window as a minimized window. The active window remains active.

8 Displays the window in its current state. The active window remains active.

9 Activates and displays the window. If the window is minimized or maximized, the system restores it to its original size and position. An application should specify this flag when restoring a minimized window.

10 Sets the show state based on the state of the program that started the application.

Example

The following example runs Microsoft Notepad and opens the currently running script:
Set WshShell = WScript.CreateObject("WScript.Shell")
WshShell.Run ("%windir%\notepad" & WScript.ScriptFullName)
The following example returns the error code from the executed application:
Set WshShell = WScript.CreateObject("WScript.Shell")
Return = WshShell.Run("notepad " & WScript.ScriptFullName, 1, TRUE)

Part	Description
object	WshShell object.
strCommand	Environment variables within the strCommand parameter are automatically expanded.
intWindowStyle	Optional. Sets the window style of the program being run.
bWaitOnReturn	Optional. If bWaitOnReturn is not specified or FALSE, immediately returns to script execution rather than waiting for the process to end. If bWaitOnReturn is set to TRUE, the Run method returns any error code returned by the application. If bWaitOnReturn is not specified or is FALSE, the Run method returns an error code of 0 (zero).

intWindowStyle	Description
0	Hides the window and activates another window.
1	Activates and displays a window. If the window is minimized or maximized, the system restores it to its original size and position. An application should specify this flag when displaying the window for the first time.
2	Activates the window and displays it as a minimized window.
3	Activates the window and displays it as a maximized window.
4	Displays a window in its most recent size and position. The active window remains active.
5	Activates the window and displays it in its current size and position.
6	Minimizes the specified window and activates the next top-level window in the Z order.
7	Displays the window as a minimized window. The active window remains active.
8	Displays the window in its current state. The active window remains active.
9	Activates and displays the window. If the window is minimized or maximized, the system restores it to its original size and position. An application should specify this flag when restoring a minimized window.
10	Sets the show state based on the state of the program that started the application.