get-environment-variable -- r7rs Definition

§

Kind

§

procedure;

Implemented by

§

• get-environment-variable (from vonuvoli);

Procedure signature

§

Procedure variants:

• ((string-not-empty) -> (string-not-empty-or-false))
  • input: a value of type string-not-empty;
  • output: a value of type string-not-empty-or-false;

Exports

§

• scheme:process-context -- (scheme process-context);

Exports recursive

§

• scheme -- (scheme);

Description

§

(get-environment-variable name)

Many operating systems provide each running process with an environment consisting of environment variables. (This environment is not to be confused with the Scheme environments that can be passed to eval: see section on environments and evaluation.) Both the name and value of an environment variable are strings. The procedure get-environment-variable returns the value of the environment variable name, or #f if the named environment variable is not found. It may use locale information to encode the name and decode the value of the environment variable. It is an error if get-environment-variable can't decode the value. It is also an error to mutate the resulting string.

(get-environment-variable "PATH") ===> "/usr/local/bin:/usr/bin:/bin"

---

The text herein was sourced and adapted as described in the "R7RS attribution of various text snippets" appendix.

Referenced-types

§

• string-not-empty;
• string-not-empty-or-false;