Go to main content

man pages section 3: Basic Library Functions

Exit Print View

Updated: Thursday, June 13, 2019
 
 

setenv(3C)

Name

setenv - add or change environment variable

Synopsis

#include <stdlib.h>

int setenv(const char *envname, const char *envval,
     int overwrite);

Description

The setenv() function updates or adds a variable in the environment of the calling process. The envname argument points to a string containing the name of an environment variable to be added or altered. The environment variable is set to the value to which envval points. The function fails if envname points to a string which contains an '=' character. If the environment variable named by envname already exists and the value of overwrite is non-zero, the function returns successfully and the environment is updated. If the environment variable named by envname already exists and the value of overwrite is zero, the function returns successfully and the environment remains unchanged.

If the application modifies environ or the pointers to which it points, the behavior of setenv() is undefined. The setenv() function updates the list of pointers to which environ points.

The strings described by envname and envval are copied by this function.

Return Values

Upon successful completion, 0 is returned. Otherwise, -1 is returned, errno set to indicate the error, and the environment is left unchanged.

Errors

The setenv() function will fail if:

EINVAL

The envname argument is a null pointer, points to an empty string, or points to a string containing an '=' character.

ENOMEM

Insufficient memory was available to add a variable or its value to the environment.

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
MT-Safe
Standard

See Also

getenv(3C), unsetenv(3C), attributes(7), standards(7)