icon Top 9 categories map      RocketAware > man pages >

getenv(3)

Tips: Browse or Search all pages for efficient awareness of more than 6000 of the most popular reusable and open source applications, functions, libraries, and FAQs.


The "RKT couplings" below include links to source code, updates, additional information, advice, FAQs, and overviews.


Home

Search all pages


Subjects

By activity
Professions, Sciences, Humanities, Business, ...

User Interface
Text-based, GUI, Audio, Video, Keyboards, Mouse, Images,...

Text Strings
Conversions, tests, processing, manipulation,...

Math
Integer, Floating point, Matrix, Statistics, Boolean, ...

Processing
Algorithms, Memory, Process control, Debugging, ...

Stored Data
Data storage, Integrity, Encryption, Compression, ...

Communications
Networks, protocols, Interprocess, Remote, Client Server, ...

Hard World
Timing, Calendar and Clock, Audio, Video, Printer, Controls...

File System
Management, Filtering, File & Directory access, Viewers, ...

    

RocketLink!--> Man page versions: OpenBSD FreeBSD RedHat Solaris Others

[ANSI C X3.159-1989]

GETENV(3)                 OpenBSD Programmer's Manual                GETENV(3)

NAME
     getenv, putenv, setenv, unsetenv - environment variable functions



SYNOPSIS
     #include <stdlib.h>

     char *
     getenv(const char *name);

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

     int
     putenv(const char *string);

     void
     unsetenv(const char *name);

DESCRIPTION
     These functions set, unset and fetch environment variables from the host
     environment list. For compatibility with differing environment conven-
     tions, the given arguments name and value may be appended and prepended,
     respectively, with an equal sign ``=''.

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

     The setenv() 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 putenv() function takes an argument of the form ``name=value'' and is
     equivalent to:

           setenv(name, value, 1);

     The unsetenv() function deletes all instances of the variable name point-
     ed to by name from the list.

RETURN VALUES
     The functions setenv() and putenv() return zero if successful; otherwise
     the global variable errno is set to indicate the error and a -1 is re-
     turned.

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

ERRORS
     [ENOMEM]  The function setenv() or putenv() failed because they were un-
               able to allocate memory for the environment.

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

STANDARDS
     The getenv() function conforms to ANSI X3.159-1989 (``ANSI C'').

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

OpenBSD 2.6                    December 11, 1993                             1

Source: OpenBSD 2.6 man pages. Copyright: Portions are copyrighted by BERKELEY
SOFTWARE DESIGN, INC., The Regents of the University of California, Massachusetts
Institute of Technology, Free Software Foundation, FreeBSD Inc., and others.



(Corrections, notes, and links courtesy of RocketAware.com)


[Detailed Topics]
FreeBSD Sources for getenv(3) functions
OpenBSD sources for getenv(3)


[Overview Topics]

Up to: Program Environment Variables - Getting/ Setting program environment variables


RocketLink!--> Man page versions: OpenBSD FreeBSD RedHat Solaris Others

[ANSI C X3.159-1989]




Rapid-Links: Search | About | Comments | Submit Path: RocketAware > man pages > getenv.3/
RocketAware.com is a service of Mib Software
Copyright 1999, Forrest J. Cavalier III. All Rights Reserved.
We welcome submissions and comments