environment_get_variable


Description

This function returns the value (a string) of the environment variable with the given name (also a string). You can get the available environment variables on macOS and Ubuntu (Linux) by typing "env" into the terminal app, and for information on Windows environment variables, if you are using the command prompt then type "echo %PATH%", and using PowerShell it's "ls env". Note that on both macOS and Ubuntu (Linux) the "HOME" environment variable will return the "~/" path which maps to "/Users/<username>" on macOS and "/home/<username>" on Ubuntu (Linux).

NOTE: This function is for Windows, macOS and Ubuntu (Linux) only.


Syntax:

environment_get_variable(name);

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


Returns:

String


Example:

e_str = environment_get_variable("APPDATA");

The above code will return the full path for the environment variable "%appdata%", which is normally "C:\Users\{username}\AppData\Roaming".