Microsoft® Windows® Script Host
Environment Property
WSH Reference
Version 1

See Also                      Applies To


Description
Returns the WshEnvironment object.
Syntax
object.Environment ([strType])
Parameters
Part Description
object WshShell object.
strType Optional. Specifies where the environment variable resides.
Remarks
If strType is supplied, it specifies where the environment variable resides, with a possible value of "System," "User," "Volatile," or "Process." If strType is not supplied, this method retrieves the system environment variables in Microsoft Windows 2000 or the process environment variables in Windows 95/98. For Windows 95/98, only "Process" is supported in the strType parameter.

The following table lists some of the variables that are provided with the Windows operating system. Scripts also can get environment variables that have been set by other applications. None of these variables are available from the "Volatile" type.

Name Description Windows 2000 Windows 95/98
System User Process Process
NUMBER_OF_PROCESSORS Number of processors running on the machine. X   X  
PROCESSOR_ARCHITECTURE Processor type of the user's workstation. X   X  
PROCESSOR_IDENTIFIER Processor ID of the user's workstation. X   X  
PROCESSOR_LEVEL Processor level of the user's workstation. X   X  
PROCESSOR_VERSION Processor version of the user's workstation. X   X  
OS Operating system on the user's workstation. X   X  
COMSPEC Executable file for the command prompt (typically cmd.exe). X   X X
HOMEDRIVE Primary local drive (typically the C drive).     X  
HOMEPATH Default directory for users (Typically \users\default in Windows 2000).     X  
PATH PATH environment variable. X X X X
PATHEXT Extensions for executable files (typically .com, .exe, .bat, or .cmd). X   X  
PROMPT Command prompt (typically $P$G).     X X
SYSTEMDRIVE Local drive on which the system directory resides (typically c:\).     X  
SYSTEMROOT System directory (for example, c:\winnt). This is the same as WINDIR.     X  
WINDIR System directory (for example, c:\winnt). This is the same as SYSTEMROOT. X   X X
TEMP Directory for storing temporary files (for example, c:\temp).   X X X
TMP Directory for storing temporary files (for example, c:\temp).   X X X

Example
The following example retrieves the NUMBER_OF_PROCESSORS system environment variable:
Set WshShell = WScript.CreateObject("WScript.Shell")
Set WshSysEnv = WshShell.Environment("SYSTEM")
WScript.Echo WshSysEnv("NUMBER_OF_PROCESSORS")