Alphabetic Keyword List

 Elements

 Errors

 Methods

 Objects

 Properties

 

Welcome to the Windows Script Host Reference

These handy blocks of information will help you explore the many different parts of the Windows Script Host.

You'll find all the parts of WSH listed alphabetically under the Alphabetic Keyword List. But if you want to examine just one category, say, objects, each language category has its own, more compact section.

How does it work? Click on one of the headings to the left to display a list of items contained in that category. From this list, select the topic that you want to view. Once you've opened that topic, you can easily link to other related sections.

So, go ahead and take a look! Study some elements, mull over the methods, or figure out a few properties. You'll see just how versatile WSH can be!

Language Element	Description
<?job ?> Element	XML processing instruction that specifies attributes for error handling.
<?XML ?> Element	Indicates that the file should be parsed as XML.
AddPrinterConnection Method	Maps the remote printer specified by strRemoteName to the local resource name strLocalName.
AddWindowsPrinterConnection Method	Adds a printer connection to Windows.
AppActivate Method	Activates an application window.
Application Property	Provides the IDispatch interface on the WScript object.
Arguments Property	Returns a pointer to the WshArguments collection or identifies arguments for the shortcut.
AtEndOfLine Property	Returns True if the stream pointer immediately precedes the end-of-line marker in an input stream; False if it is not.
AtEndOfStream Property	Returns True if the stream pointer is at the end of an input stream; False if it is not.
Close Method	Closes an open stream.
Column Property	Returns the column number of the current character position in an input stream.
ComputerName Property	Provides a string representation of the computer name.
ConnectObject Method	Connects an objects event sources to functions with a given prefix.
Count Property	Returns the number of enumerated items.
CreateObject Method	Creates an object specified by the strProgID parameter.
CreateShortcut Method	Creates an object reference to a shortcut or URLshortcut.
Description Property	Provides a description of a shortcut object.
DisconnectObject Method	Disconnects a previously connected object from Windows Script Host.
Echo Method	Displays parameters in a window.
EnumNetworkDrives Method	Returns the current network drive mappings.
EnumPrinterConnections Method	Returns the current network printer mappings.
Environment Property	Returns the WshEnvironment object.
Errors	Lists Windows Script Host error messages.
ExpandEnvironmentStrings Method	Expands the PROCESS environment variable and returns the result string.
FullName Property	Returns a string containing the full path to the host executable or shortcut object.
GetObject Method	Retrieves an Automation object from a file, or an object specified by the strProgID parameter.
getResource Method	Gets the value of a resource defined with the <resource> element.
HotKey Property	Provides the hotkey of a shortcut object.
IconLocation Property	Provides the icon location of a shortcut object.
Item Property	Returns a specified item from a collection.
<job> Element	Allows for multiple jobs to be defined in a single file. Since this is an enclosing tag, every tag within the Job tag will apply to that job.
Length Property	Returns the number of enumerated items.
Line Property	Returns the current line number in an input stream.
LogEvent Method	Logs an event in the Windows NT event log or WSH.log file.
MapNetworkDrive Method	Maps the share point specified by strRemoteName to the local resource name strLocalName.
Name Property	Provides a string containing the friendly name of the WScript object.
<object> Element	XML element used in scriptlet files that defines objects that can be referenced by script.
<package> Element	Encloses multiple job definitions.
Path Property	Provides a string containing the name of the directory where WScript.Exe or Cscript.Exe resides.
Popup Method	Displays a popup message box window that contains the message contained in strText.
Quit Method	Quits execution with a specified error code.
Read Method	Reads a specified number of characters from an input stream and returns the resulting string.
ReadAll Method	Reads an entire input stream and returns the resulting string.
ReadLine Method	Reads an entire line (up to, but not including, the newline character) from an input stream and returns the resulting string.
<reference> Element	XML element used in Windows Script Component files that includes a reference to an external type library.
RegDelete Method	Deletes from the registry the key or value named strName.
RegRead Method	Returns the registry key or value named by strName.
RegWrite Method	Sets the registry key or value named by strName.
Remove Method	Deletes the environment variable specified by strName.
RemoveNetworkDrive Method	Removes the current resource connection denoted by strName.
RemovePrinterConnection Method	Removes the current resource connection denoted by strName.
<resource> Element	XML element isolates textual or numeric data that should not be hard-coded into the scripts.
Run Method	Creates a new process that executes strCommand.
Save Method	Saves a shortcut to the specified location.
<script> Element	XML element that contains script to define the Windows Script Component's behavior.
ScriptFullName Property	Provides the full path to the script being run.
ScriptName Property	Provides the file name of the script being run.
SendKeys Method	Sends one or more keystrokes to the active window as if typed at the keyboard.
SetDefaultPrinter Method	Sets the default printer to the remote printer specified.
Skip Method	Skips a specified number of characters when reading an input stream.
SkipLineMethod	Skips the next line when reading an input stream.
Sleep Method	Places the script process into an inactive state for the number of milliseconds specified and then continues execution.
SpecialFolders Property	Provides the WshSpecialFolders object for accessing Windows shell folders such as the desktop folder, the Start menu folder, and the personal document folder.
StdErr Property	Exposes the write-only error output stream for the current script.
StdIn Property	Exposes the read-only input stream for the current script.
StdOut Property	Exposes the write-only output stream for the current script.
TargetPath Property	Sets the path of the file to execute of a shortcut object.
UserDomain Property	Provides a string representation of the user domain name.
UserName Property	Provides a string representation of the user name.
Version Property	Returns the version of the Windows Script Host.
WindowStyle Property	Provides the window style of a shortcut object.
WorkingDirectory Property	Provides the working directory of a shortcut object.
Write Method	Writes a specified string to an output stream.
WriteBlankLines Method	Writes a specified number of newline characters to an output stream.
WriteLine Method	Writes a specified string and newline character to an output stream.
WScript Object	Exposes properties that tell the path of the running scripting host (wscript.exe or cscript.exe), its arguments, and the working mode (interactive or batch). The WScript object also provides methods to create and read objects.
WshArguments Object	Returns a pointer to the collection of command-line parameters.
WshEnvironment Object	Retrieves the system environment variables.
WshNetwork Object	Maps the network, making it easy to connect and disconnect remote drives and printers.
WshShell Object	Starts a new process and creates shortcuts, and provides the Environment collection to handle environmental variables such as WINDIR, PATH, or PROMPT.
WshShortcut Object	Creates an object reference to a shortcut.
WshSpecialFolders Object	Accesses the Windows shell folders such as the desktop folder, the Start menu folder, and the personal document folder.
WshUrlShortcut Object	Creates an object reference to URLshortcut.

Language Element	Description
<?job ?> Element	XML processing instruction that specifies attributes for error handling.
<?XML ?> Element	Indicates that the file should be parsed as XML.
<job> Element	Allows for multiple jobs to be defined in a single file. Since this is an enclosing tag, every tag within the Job tag will apply to that job.
<object> Element	XML element used in Windows Script Component files that defines objects that can be referenced by script.
<package> Element	Encloses multiple job definitions.
<reference> Element	XML element used in Windows Script Component files that includes a reference to an external type library.
<resource> Element	XML element isolates textual or numeric data that should not be hard-coded into the scripts.
<script> Element	XML element that contains script to define the Windows Script Component's behavior.

Language Element	Description
Error List	List of Windows Script Host Error messages.

Language Element	Description
AddPrinterConnection Method	Maps the remote printer specified by strRemoteName to the local resource name strLocalName.
AddWindowsPrinterConnection Method	Adds a printer connection to Windows.
AppActivate Method	Activates an application window.
Close Method	Closes an open stream.
ConnectObject Method	Connects an objects event sources to functions with a given prefix.
CreateObject Method	Creates an object specified by the strProgID parameter.
CreateShortcut Method	Creates an object reference to a shortcut or URLshortcut.
DisconnectObject Method	Disconnects a previously connected object from Windows Script Host.
Echo Method	Displays parameters in a window.
EnumNetworkDrives Method	Returns the current network drive mappings.
EnumPrinterConnections Method	Returns the current network printer mappings.
ExpandEnvironmentStrings Method	Expands the PROCESS environment variable and returns the result string.
GetObject Method	Retrieves an Automation object from a file, or an object specified by the strProgID parameter.
getResource Method	Gets the value of a resource defined with the <resource> element.
LogEvent Method	Logs an event in the Windows NT event log or WSH.log file.
MapNetworkDrive Method	Maps the share point specified by strRemoteName to the local resource name strLocalName.
Popup Method	Displays a popup message box window that contains the message contained in strText.
Quit Method	Quits execution with a specified error code.
Read Method	Reads a specified number of characters from an input stream and returns the resulting string.
ReadAll Method	Reads an entire input stream and returns the resulting string.
ReadLine Method	Reads an entire line (up to, but not including, the newline character) from an input stream and returns the resulting string.
RegDelete Method	Deletes from the registry the key or value named strName.
RegRead Method	Returns the registry key or value named by strName.
RegWrite Method	Sets the registry key or value named by strName.
Remove Method	Deletes the environment variable specified by strName.
RemoveNetworkDrive Method	Removes the current resource connection denoted by strName.
RemovePrinterConnection Method	Removes the current resource connection denoted by strName.
Run Method	Creates a new process that executes strCommand.
Save Method	Saves a shortcut to the specified location.
SendKeys Method	Sends one or more keystrokes to the active window as if typed at the keyboard.
SetDefaultPrinter Method	Sets the default printer to the remote printer specified.
Skip Method	Skips a specified number of characters when reading an input stream.
SkipLineMethod	Skips the next line when reading an input stream.
Sleep Method	Places the script process into an inactive state for the number of milliseconds specified and then continues execution.
Write Method	Writes a specified string to an output stream.
WriteBlankLines Method	Writes a specified number of newline characters to an output stream.
WriteLine Method	Writes a specified string and newline character to an output stream.

Language Element	Description
WScript Object	Exposes properties that tell the path of the running scripting host (wscript.exe or cscript.exe), its arguments, and the working mode (interactive or batch). The WScript object also provides methods to create and read objects.
WshArguments Object	Returns a pointer to the collection of command-line parameters.
WshEnvironment Object	Retrieves the system environment variables.
WshNetwork Object	Maps the network, making it easy to connect and disconnect remote drives and printers.
WshShell Object	Starts a new process and creates shortcuts, and provides the Environment collection to handle environmental variables such as WINDIR, PATH, or PROMPT.
WshShortcut Object	Creates an object reference to a shortcut.
WshSpecialFolders Object	Accesses the Windows shell folders such as the desktop folder, the Start menu folder, and the personal document folder.
WshUrlShortcut Object	Creates an object reference to URLshortcut.

Language Element	Description
Application Property	Provides the IDispatch interface on the WScript object.
Arguments Property	Returns a pointer to the WshArguments collection or identifies arguments for the shortcut.
AtEndOfLine Property	Returns True if the stream pointer immediately precedes the end-of-line marker in an input stream; False if it is not.
AtEndOfStream Property	Returns True if the stream pointer is at the end of an input stream; False if it is not.
Column Property	Returns the column number of the current character position in an input stream.
ComputerName Property	Provides a string representation of the computer name.
Count Property	Returns the number of enumerated items.
Description Property	Provides a description of a shortcut object.
Environment Property	Returns the WshEnvironment object.
FullName Property	Returns a string containing the full path to the host executable or shortcut object.
HotKey Property	Provides the hotkey of a shortcut object.
IconLocation Property	Provides the icon location of a shortcut object.
Item Property	Returns a specified item from a collection.
Length Property	Returns the number of enumerated items.
Line Property	Returns the current line number in an input stream.
Name Property	Provides a string containing the friendly name of the WScript object.
Path Property	Provides a string containing the name of the directory where WScript.Exe or CScript.Exe resides.
ScriptFullName Property	Provides the full path to the script being run.
ScriptName Property	Provides the file name of the script being run.
SpecialFolders Property	Provides the WshSpecialFolders object for accessing Windows shell folders such as the desktop folder, the Start menu folder, and the personal document folder.
StdErr Property	Exposes the write-only error output stream for the current script.
StdIn Property	Exposes the read-only input stream for the current script.
StdOut Property	Exposes the write-only output stream for the current script.
TargetPath Property	Sets the path of the file to execute of a shortcut object.
UserDomain Property	Provides a string representation of the user domain name.
UserName Property	Provides a string representation of the user name.
Version Property	Returns the version of the Windows Script Host.
WindowStyle Property	Provides the window style of a shortcut object.
WorkingDirectory Property	Provides the working directory of a shortcut object.