xref: /original-bsd/lib/libc/stdlib/getenv.3 (revision abe165e9)
Copyright (c) 1988 The Regents of the University of California.
All rights reserved.

%sccs.include.redist.man%

@(#)getenv.3 6.9 (Berkeley) 05/17/90

GETENV 3 ""
.AT 3
NAME
getenv, putenv, setenv, unsetenv - manipulate environmental variables
SYNOPSIS
#include <stdlib.h>

char *
getenv(const char *name);

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

putenv(const char *string);

void
unsetenv(const char *name);
DESCRIPTION
Getenv searches the environment list (see environ (7)) for a string of the form name=value and returns a pointer to the string value if such a string is present, and a NULL pointer if it is not.

Setenv searches the environment list as getenv does; if the string name is not found, a string of the form name=value is added to the environment. If it is found, and overwrite is non-zero, its value is changed to value . Setenv returns 0 on success and -1 on failure, setting the external variable errno .

Putenv takes an argument of the form ``name=value'' and is the equivalent of:

setenv(name, value, 1);

Unsetenv removes all occurrences of the string name from the environment. There is no library provision for completely removing the current environment. It is suggested that the following code be used to do so.

static char *envinit[1];
extern char **environ;
environ = envinit;

All of these routines permit, but do not require, a trailing equals (``='') sign on name or a leading equals sign on value .

ERRORS

[ENOMEM] Setenv or putenv failed because they were unable to allocate memory for the environment.

SEE ALSO
csh(1), sh(1), execve(2), environ(7)
STANDARDS
Getenv conforms to ANSI X3.159-1989 (``ANSI C'').