Properties (Windows Script Host)

The following sections include information about the properties of Windows Script Host.

In This Section

• Arguments Property (WScript Object)
  Returns the WshArguments object.

• Arguments Property (Shortcut Object)
  Sets the arguments for a shortcut, or identifies a shortcut's arguments.

• AtEndOfLine Property
  Returns a Boolean value indicating whether the end of an input line has been reached.

• AtEndOfStream Property
  Returns a Boolean value indicating whether the end of an input stream has been reached.

• BuildVersion Property
  Returns the Windows Script Host build version number.

• Character Property
  Reports the specific character in the line of code that contained the error.

• Column Property
  Returns the column number of the current character position in an input stream.

• ComputerName Property
  Returns the name of the computer.

• CurrentDirectory Property
  Allows you to set or retrieve the active script's current working folder.

• Description Property
  Returns the description of a shortcut.

• Description Property (WshRemoteError)
  Contains a brief description of the error that caused the remote script to terminate.

• Environment Property
  Returns the WshEnvironment object.

• Error Property (WshRemote)
  Exposes a WshRemoteError object.

• ExitCode Property
  Returns the exit code set by a script/program run using the Exec() method.

• FullName Property(WScript Object)
  Returns a fully qualified path name.

• FullName Property (WshShortcut Object)
  Returns the fully qualified path of the shortcut object's target.

• FullName Property (WshUrlShortcut Object)
  Returns the fully qualified path of the shortcut object's target.

• Hotkey Property
  Allows you to assign a key combination to a shortcut and determine the key combination to a shortcut.

• IconLocation Property
  Allows you to assign an icon to a shortcut and determine which icon has been assigned to a shortcut.

• Interactive Property
  Allows you to set the script mode programmatically, as well as determine the script mode programmatically.

• Item Property
  Exposes a specified item from a collection.

• Item Property (WshNamed)
  Provides access to the items in the WshNamed object.

• Item Property (WshUnnamed)
  Returns an item using a zero-based index.

• length Property (WshArguments Object)
  Returns the number of items in a collection.

• length Property (WshEnvironment Object)
  Returns the number of Windows environment variables on the local computer system (the number of items in an Environment collection).

• length Property (WshSpecialFolders Object)
  Returns the number of Windows special folders on the local computer system (the number of items in a SpecialFolders collection).

• Line Property (WScript)
  Returns the current line number in an input stream.

• Line Property (WshRemoteError)
  Identifies the line in a script that contains an error-causing statement.

• Name Property (WScript Object)
  Returns the friendly name of the WScript object (the host executable file).

• Named Property
  Returns the WshNamed object (a collection of named arguments).

• Number Property
  Reports the error number representing a script error.

• Path Property
  Returns the name of the directory containing the WScript object (the host executable file).

• ProcessID Property
  Reports the process ID (PID) of a process started with the WshScriptExec object.

• RelativePath Property
  Assigns a relative path to a shortcut, or identifies the relative path of a shortcut.

• ScriptFullName Property
  Returns the full path-name of the currently running script.

• ScriptName Property
  Returns the file name of the currently running script.

• Source Property
  Identifies the COM object responsible for causing the script error.

• SourceText Property
  Contains the line of source code that caused an error.

• SpecialFolders Property
  Returns the WshSpecialFolders object.

• Status Property (WshRemote)
  Reports the current running-condition of the remote script.

• Status Property (WshScriptExec)
  Provides status information about a script run with the Exec() method.

• StdErr Property (WScript)
  Exposes the write-only error output stream for the current script.

• StdErr Property (WshScriptExec)
  Exposes the read-only stderr output stream of the Exec object.

• StdIn Property (WScript)
  Exposes the read-only input stream for the current script.

• StdIn Property (WshScriptExec)
  Exposes the write-only stdin input stream of the Exec object.

• StdOut Property (WScript)
  Exposes the write-only output stream for the current script.

• StdOut Property (WshScriptExec)
  Exposes the write-only stdout output stream of the Exec object.

• TargetPath Property
  Allows you to assign a path to the executable file to which a shortcut points, as well as determine the path to the executable file pointed to by a shortcut.

• Unnamed Property
  Returns the WshUnnamed object (a collection of unnamed arguments).

• UserDomain Property
  Returns the user's domain name.

• UserName Property
  Returns the name of the user.

• Version Property
  Returns the version of WSH.

• WindowStyle Property
  Allows you to assign a window style to a shortcut, as well as determine the type of window style used by a shortcut.

• WorkingDirectory Property
  Allows you to assign a working directory to a shortcut, as well as determine the working directory used by a shortcut.

Related Sections

• WSH Language
  List of elements that make up WSH Reference.

• Windows Script Host Basics
  Learn the basics of WSH.