Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

putenv(3) [php man page]

PUTENV(3)								 1								 PUTENV(3)

putenv - Sets the value of an environment variable

SYNOPSIS
bool putenv (string $setting) DESCRIPTION
Adds $setting to the server environment. The environment variable will only exist for the duration of the current request. At the end of the request the environment is restored to its original state. Setting certain environment variables may be a potential security breach. The safe_mode_allowed_env_vars directive contains a comma-delim- ited list of prefixes. In Safe Mode, the user may only alter environment variables whose names begin with the prefixes supplied by this directive. By default, users will only be able to set environment variables that begin with PHP_ (e.g. PHP_FOO=BAR). Note: if this direc- tive is empty, PHP will let the user modify ANY environment variable! The safe_mode_protected_env_vars directive contains a comma-delimited list of environment variables, that the end user won't be able to change using putenv(3). These variables will be protected even if safe_mode_allowed_env_vars is set to allow to change them. PARAMETERS
o $setting - The setting, like "FOO=BAR" RETURN VALUES
Returns TRUE on success or FALSE on failure. EXAMPLES
Example #1 Setting an environment variable <?php putenv("UNIQID=$uniqid"); ?> NOTES
Warning The safe_mode_allowed_env_vars and safe_mode_protected_env_vars directives only take effect when safe_mode is enabled. SEE ALSO
getenv(3). PHP Documentation Group PUTENV(3)

Check Out this Related Man Page

PUTENV(3)						     Linux Programmer's Manual							 PUTENV(3)

NAME
putenv - change or add an environment variable SYNOPSIS
#include <stdlib.h> int putenv(char *string); Feature Test Macro Requirements for glibc (see feature_test_macros(7)): putenv(): _SVID_SOURCE || _XOPEN_SOURCE DESCRIPTION
The putenv() function adds or changes the value of environment variables. The argument string is of the form name=value. If name does not already exist in the environment, then string is added to the environment. If name does exist, then the value of name in the environment is changed to value. The string pointed to by string becomes part of the environment, so altering the string changes the environment. RETURN VALUE
The putenv() function returns zero on success, or nonzero if an error occurs. In the event of an error, errno is set to indicate the cause. ERRORS
ENOMEM Insufficient space to allocate new environment. CONFORMING TO
SVr4, POSIX.1-2001, 4.3BSD. NOTES
The putenv() function is not required to be reentrant, and the one in libc4, libc5 and glibc 2.0 is not, but the glibc 2.1 version is. Description for libc4, libc5, glibc: If the argument string is of the form name, and does not contain an '=' character, then the variable name is removed from the environment. If putenv() has to allocate a new array environ, and the previous array was also allocated by putenv(), then it will be freed. In no case will the old storage associated to the environment variable itself be freed. The libc4 and libc5 and glibc 2.1.2 versions conform to SUSv2: the pointer string given to putenv() is used. In particular, this string becomes part of the environment; changing it later will change the environment. (Thus, it is an error is to call putenv() with an auto- matic variable as the argument, then return from the calling function while string is still part of the environment.) However, glibc 2.0-2.1.1 differs: a copy of the string is used. On the one hand this causes a memory leak, and on the other hand it violates SUSv2. This has been fixed in glibc 2.1.2. The 4.4BSD version, like glibc 2.0, uses a copy. SUSv2 removes the const from the prototype, and so does glibc 2.1.3. SEE ALSO
clearenv(3), getenv(3), setenv(3), unsetenv(3), environ(7) COLOPHON
This page is part of release 3.53 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://www.kernel.org/doc/man-pages/. GNU
2013-04-19 PUTENV(3)
Man Page