getenv3

Usage

Library

Standard C Library (libc, -lc)

Overview

These functions set, unset and fetch environment variables from the host environment list.

The getenv() function obtains the current value of the environment variable, name. The application should not modify the string pointed to by the getenv() function.

The setenv() function inserts or resets the environment variable name in the current environment list. If the variable name does not exist in the list, it is inserted with the given value. If the variable does exist, the argument overwrite is tested; if overwrite is zero, the variable is not reset, otherwise it is reset to the given value.

The putenv() function takes an argument of the form ``name=value'' and is equivalent to:

setenv(name, value, 1);

The string pointed to by string becomes part of the environment. A program should not alter or free the string, and should not use stack or other transient string variables as arguments to putenv(). The setenv() function is strongly preferred to putenv().

The unsetenv() function deletes all instances of the variable name pointed to by name from the list. Note that only the variable name (e.g., "NAME") should be given; "NAME=value" will not work.

Return values

The getenv() function returns the value of the environment variable as aNUL -terminated string. If the variable name is not in the current environment, NULL is returned.

The setenv(), putenv(), and unsetenv() functions return the value 0 if successful; otherwise the value -1 is returned and the global variable errno is set to indicate the error.

Errors

[EINVAL]

The function getenv(), setenv() or unsetenv() failed because the name is a NULL pointer, points to an empty string, or points to a string containing an “=” character.

The function putenv() failed because string is a NULL pointer or string is without an “=” character.

[ENOMEM]

The function setenv(), unsetenv() or putenv() failed because it was unable to allocate memory for the environment.

Legacy synopsis

#include <stdlib.h>

void
unsetenv(const char *name);

unsetenv() doesn't return a value.

Compatibility

putenv() no longer copies its input buffer. This often appears in crash logs as a crash in getenv(). Avoid passing local buffers or freeing the memory that is passed to putenv(). Use setenv(), which still makes an internal copy of its buffers.

unsetenv() no longer parses the variable name; e.g., unsetenv ("FOO=BAR") no longer works. Use unsetenv("FOO"). unsetenv() also now returns a status value and will set errno to EINVAL if name is not a defined environment variable.