environment_get_variable

Syntax:

environment_get_variable(name);


Argument Description
name The name (a string) of the environment variable to check.


Returns: String


Description

This function returns the value (a string) of the environment variable with the given name (also a string).

NOTE: This is a Windows only function.


Example:

e_str = environment_get_variable("APPDATA");

The above code will return the full path for the environment variable "%appdata%", which in Windows XP is normally "C:\Documents and Settings\{username}\Application Data" and in Windows Vista/7 "C:\Users\{username}\AppData\Roaming".