ExpandEnvironmentStrings Method

Switch View

ExpandEnvironmentStrings Method

Collapse All

Language Filter

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

ExpandEnvironmentStrings Method

Returns an environment variable's expanded value.

object.ExpandEnvironmentStrings(strString)

Arguments

object: WshShell object.
strString: String value indicating the name of the environment variable you want to expand.

Remarks

The ExpandEnvironmentStrings method expands environment variables defined in the PROCESS environment space only. Environment variable names, which must be enclosed between "%" characters, are not case-sensitive.

Example

The following code expands the Windows Directory environment variable and displays it:

VBScript

set WshShell = WScript.CreateObject("WScript.Shell")
WScript.Echo "WinDir is " & WshShell.ExpandEnvironmentStrings("%WinDir%")

JScript

var WshShell = WScript.CreateObject("WScript.Shell");
WScript.Echo("WinDir is " + WshShell.ExpandEnvironmentStrings("%WinDir%"));

Applies To:

WshShell Object

Reference

RegRead Method

Tags

: Add a tag

Community Content

Add new content

Annotations

It may seem obvious but...

John Sudds | Edit | Show History

If the environment variable is not defined, the method cannot "expand" the value and returns a string equal to the input.

var oShell = new ActiveXObject("WScript.Shell");
var strReturn = oShell.ExpandEnvironmentStrings("%MISSING%");
WScript.Echo(strReturn);

Example output: %MISSING%