getEnvironmentVariable

From RPTools Wiki
Jump to navigationJump to search

getEnvironmentVariable() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 1.5.0
Retrieves an operating system environment variable as a string.

This function is useful for situations where the script may wish to interact with the environment outside of MapTool, such as using the exportData() function to write a string to an external file.

Caution:
This function is considered experimental and its implementation and parameters may change.

The Allow External Macro Access option on the Application tab of MapTool's Preferences must be enabled or this macro aborts with an error.

Usage

getEnvironmentVariable(varname)

The value of varname specifies which environment variable is queried. On most operating systems, environment variables are all uppercase letters, but this is a naming convention and not required. Note that no way exists to query what all of the environment variables are, so the script writer must know which variable they want to retrieve.

Example

You can use the following code to print the value of the PATH environment variable (which exists on most systems). Knowing the list of directories where an operating system searches for compiled executables could be considered a security vulnerability. See the above note about the Allow External Macro Access option.
[getEnvironmentVariable("PATH")]
[getEnvironmentVariable("TEMP")]
[getEnvironmentVariable("USERNAME")]