Windows Script Host Object Model

Windows Script Host Object Model

Switch on low bandwidth view

Collapse All

This page is specific to

.NET Framework 3.0

Other versions are also available for the following:

Microsoft Visual Studio 2005/.NET Framework 2.0

Windows Script Host

Windows Script Host Object Model

Updated: April 2009

The Windows Script Host object model consists of 14 objects. The root object is the WScript object.

Object Model Illustration

The illustration that follows represents the Windows Script Host Object Model hierarchy.

The Windows Script Host object model provides a logical, systematic way to perform many administrative tasks. The set of COM interfaces it provides can be placed into two main categories:

Script Execution and Troubleshooting
This set of interfaces allows scripts to perform basic manipulation of the Windows Script Host, output messages to the screen, and perform basic COM functions such as CreateObject and GetObject.
Helper Functions
Helper functions are properties and methods for performing actions, such as mapping network drives, connecting to printers, retrieving and modifying environment variables, and manipulating registry keys. Administrators can also use the Windows Script Host helper functions to create simple logon scripts.

WSH Objects and Associated Tasks

The following table is a list of the WSH objects and the typical tasks associated with them.

Object	What you can do with this object
WScript Object	Set and retrieve command line arguments Determine the name of the script file Determine the host file name (wscript.exe or cscript.exe) Determine the host version information Create, connect to, and disconnect from COM objects Sink events Stop a script's execution programmatically Output information to the default output device (for example, a dialog box or the command line)
WshArguments Object	Access the entire set of command-line arguments
WshNamed Object	Access the set of named command-line arguments
WshUnnamed Object	Access the set of unnamed command-line arguments
WshNetwork Object	Connect to and disconnect from network shares and network printers Map and unmap network shares Access information about the currently logged-on user
WshController Object	Create a remote script process using the Controller method CreateScript()
WshRemote Object	Remotely administer computer systems on a computer network Programmatically manipulate other programs/scripts
WshRemoteError Object	Access the error information available when a remote script (a WshRemote object) terminates as a result of a script error
WshShell Object	Run a program locally Manipulate the contents of the registry Create a shortcut Access a system folder Manipulate environment variables (such as WINDIR, PATH, or PROMPT)
WshShortcut Object	Programmatically create a shortcut
WshSpecialFolders Object	Access any of the Windows Special Folders
WshUrlShortcut Object	Programmatically create a shortcut to an Internet resource
WshEnvironment Object	Access any of the environment variables (such as WINDIR, PATH, or PROMPT)
WshScriptExec Object	Determine status and error information about a script run with Exec() Access the StdIn, StdOut, and StdErr channels

In addition to the object interfaces provided by Windows Script Host, administrators can use any ActiveX control that exposes automation interfaces to perform various tasks on the Windows platform. For example, administrators can write scripts to manage the Windows Active Directory Service Interface (ADSI).

Change History

Date	History	Reason
April 2009	Added links to listed objects.	Customer feedback.

Date

History

Reason

April 2009

Added links to listed objects.

Customer feedback.