getenv

Environment variable

Syntax

val = getenv(varname)

val = getenv()

Description

val = getenv(varname) returns the value of the operating system environment variable varname. If varname does not exist, then getenv returns an empty character vector.

On UNIX^® platforms, the shell you use to start MATLAB^® determines the operating system environment. For example, on a Mac platform, starting MATLAB from the Applications folder creates an environment that is different from that created by starting MATLAB from Terminal.

val = getenv() returns a dictionary of strings containing all environment names and values.

Examples

Display System Root Directory on Windows

res = getenv("SYSTEMROOT")

res = 'C:\windows'

Display Values of Multiple Environment Variables

val = getenv(["VarName1"; "VarName2"])

val =

  2×1 string array

    "VarVal1"
    "VarVal2"                                        

Input Arguments

varname — Environment variable names

string scalar | character vector | string array | cell array of character vectors

Environment variable names, specified as a string scalar, character vector, string array, or cell array of character vectors.

Example: "PATH"

Output Arguments

val — Environment variable values

string scalar | character vector | string array | cell array of character vectors | dictionary of strings

Environment variable values, returned as a string scalar, character vector, string array, cell array of character vectors, or dictionary of strings. The type and dimensions of the returned output value is determined by the input value:

• If varname is a nonscalar string array or cell array of character vectors, then val has the same type and dimensions as varname.

• If no input value is provided, then val is a dictionary of strings containing all environment variable names and values.

• If varname is a string scalar, then val is a character vector.

Extended Capabilities

C/C++ Code Generation
Generate C and C++ code using MATLAB® Coder™.

Thread-Based Environment

Run code in the background using MATLAB® backgroundPool or accelerate code with Parallel Computing Toolbox™ ThreadPool.

This function fully supports thread-based environments. For more information, see Run MATLAB Functions in Thread-Based Environment.

Version History

Introduced before R2006a

R2023a: Get values of multiple environment variables

Get the values of multiple environment variables by using getenv with a string array or cell array of character vectors as input.