| Defined in header
|
||
| char *getenv( const char *name ); |
(1) | |
| errno_t getenv_s( size_t *restrict len, char *restrict value, rsize_t valuesz, const char *restrict name ); |
(2) | (since C11) |
name in the host-specified environment list and returns a pointer to the string that is associated with the matched environment variable. The set of environmental variables and methods of altering it are implementation-defined.getenv, as well as a call to the POSIX functions setenv(), unsetenv(), and putenv() may invalidate the pointer returned by a previous call or modify the string obtained from a previous call.getenv invokes undefined behavior.value (unless null) and the number of bytes written is stored in the user-provided location *len (unless null). If the environment variable is not set in the environment, zero is written to *len (unless null) and '\0' is written to value[0] (unless null). In addition, the following errors are detected at runtime and call the currently installed constraint handler function:
-
nameis a null pointer -
valueszis greater than RSIZE_MAX -
valueis a null pointer andvalueszis not zero
-
- As with all bounds-checked functions,
getenv_sis only guaranteed to be available if__STDC_LIB_EXT1__is defined by the implementation and if the user defines__STDC_WANT_LIB_EXT1__to the integer constant1before including<stdlib.h>.
Parameters
| name | - | null-terminated character string identifying the name of the environmental variable to look for |
| len | - | pointer to a user-provided location where getenv_s will store the length of the environment variable
|
| value | - | pointer to a user-provided character array where getenv_s will store the contents of the environment variable
|
| valuesz | - | maximum number of characters that getenv_s is allowed to write to dest (size of the buffer)
|
Return value
*len (unless len is a null pointer).Notes
On POSIX systems, the environment variables are also accessible through the global variable environ, declared as extern char **environ; in <unistd.h>, and through the optional third argument, envp, of the main function.
The call to getenv_s with a null pointer for value and zero for valuesz is used to determine the size of the buffer required to hold the entire result.
Example
#include <stdio.h>
#include <stdlib.h>
int main(void)
{
const char *name = "PATH";
const char *env_p = getenv(name);
if (env_p)
printf("Your %s is %s\n", name, env_p);
}Your PATH is /home/gamer/.local/bin:/usr/local/bin:/usr/bin:/bin:/usr/share/gamesReferences
- C23 standard (ISO/IEC 9899:2024):
- 7.22.4.6 The getenv function (p: TBD)
- K.3.6.2.1 The getenv_s function (p: TBD)
- C17 standard (ISO/IEC 9899:2018):
- 7.22.4.6 The getenv function (p: 256-257)
- K.3.6.2.1 The getenv_s function (p: 440-441)
- C11 standard (ISO/IEC 9899:2011):
- 7.22.4.6 The getenv function (p: 352-353)
- K.3.6.2.1 The getenv_s function (p: 606-607)
- C99 standard (ISO/IEC 9899:1999):
- 7.20.4.5 The getenv function (p: 317)
- C89/C90 standard (ISO/IEC 9899:1990):
- 4.10.4.4 The getenv function
See also
| C++ documentation for getenv
|
Content from this page on cppreference.com, licensed under CC-BY-SA 3.0 and GFDL. Modified: restyled, site navigation removed, code windows added. Offline snapshot of 9 February 2025.