OpenBSD manual page server

Manual Page Search Parameters

GETENV(3) Library Functions Manual GETENV(3)

getenv, putenv, setenv, unsetenvenvironment variable functions

#include <stdlib.h>

char *
getenv(const char *name);

setenv(const char *name, const char *value, int overwrite);

putenv(char *string);

unsetenv(const char *name);

These functions set, unset, and fetch environment variables from the host . For compatibility with differing environment conventions, the given argument name may be appended with an equal sign “=” followed by zero or more characters, and value may be prepended with an equal sign.

The () function obtains the current value of the environment variable name. If the variable name is not in the current environment, a null pointer is returned.

The () 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 () function takes an argument of the form name=value. The memory pointed to by string becomes part of the environment and must not be deallocated by the caller. If the variable already exists, it will be overwritten. A common source of bugs is to pass a string argument that is a locally scoped string buffer. This will result in corruption of the environment after leaving the scope in which the variable is defined. For this reason, the setenv() function is preferred over putenv().

The () function deletes all instances of the variable name pointed to by name from the list.

These functions return zero if successful; otherwise the global variable errno is set to indicate the error and -1 is returned.

If getenv() is successful, the string returned should be considered read-only.

The setenv() or unsetenv() function was passed a name containing an ‘=’ character.

The unsetenv() function was passed an empty name or a NULL pointer.

The putenv() function was passed a string that did not contain an ‘=’ character.

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

csh(1), sh(1), execve(2), environ(7)

The getenv() function conforms to ANSI X3.159-1989 (“ANSI C89”).

The function getenv() appeared in Version 7 AT&T UNIX and 3BSD. The functions setenv() and unsetenv() appeared in 4.3BSD-Tahoe. The putenv() function appeared in 4.3BSD-Reno.

April 27, 2011 OpenBSD-5.1