mSystem.getEnvironmentVariable()

Availability

Windows: Flash 8 or 9 AS2.0 SWF + mProjector 3.0; Windows 98/ME/NT Support: Flash 7 SWF + mProjector 2.0;

Macintosh: Not Applicable

Usage

mSystem.getEnvironmentVariable(variableName:String) : String

Parameters

variableName - Name of the environment variable to retrieve - one of the following values.

"ALLUSERSPROFILE" - Local returns the location of the All Users Profile.
"APPDATA" - Local returns the location where applications store data by default.
"COMPUTERNAME" - System returns the name of the computer.
"COMSPEC" - System returns the exact path to the command shell executable.
"HOMEDRIVE" - ystem returns which local workstation drive letter is connected to the user's home directory. This variable is set based on the value of the home directory. The user's home directory is specified in Local Users and Groups.
"HOMEPATH" - System returns the full path of the user's home directory. This variable is set based on the value of the home directory. The user's home directory is specified in Local Users and Groups.
"HOMESHARE" - System returns the network path to the user's shared home directory. This variable is set based on the value of the home directory. The user's home directory is specified in Local Users and Groups.
"LOGONSERVER" - Local returns the name of the domain controller that validated the current logon session.
"NUMBER_OF_PROCESSORS" - System specifies the number of processors installed on the computer.
"OS" - System returns the OS name. Windows XP and Windows 2000 display the OS as Windows_NT.
"PATH" - System specifies the search path for executable files.
"PROCESSOR_ARCHITECTURE" - System returns the processor's chip architecture. Values: x86, IA64.
"PROCESSOR_IDENTFIER" - System returns a description of the processor.
"PROCESSOR_LEVEL" - System returns the model number of the computer's processor.
"PROCESSOR_REVISION" - System returns the revision number of the processor.
"SYSTEMDRIVE" - System returns the drive containing the Windows root directory (i.e., the system root).
"SYSTEMROOT" - System returns the location of the Windows root directory.
"TEMP" - System and User return the default temporary directories for applications that are available to users who are currently logged on. Some applications require TEMP and others require TMP.
"TMP" - System and User return the default temporary directories for applications that are available to users who are currently logged on. Some applications require TEMP and others require TMP.
"USERDOMAIN" - Local returns the name of the domain that contains the user's account.
"USERNAME" - Local returns the name of the user currently logged on.
"USERPROFILE" - Local returns the location of the profile for the current user.
"WINDIR" - System returns the location of the OS directory.

Returns

A string.; ;

Description

Method; Retrieves the specified environment variable. Many of these variables are paths to file doirectories on machine that can be accessed using mSystem.getSpecialFolder().

Example

The following example retrieves the the Windows directory -- WINDIR environment variable.

var WindowsFolder = mSystem.getEnvironmentVariable("WINDIR");