usr/src/man/man3c/getenv.3c

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH GETENV 3C "Jul 24, 2002"
   7 .SH NAME
   8 getenv \- return value for environment name
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <stdlib.h>
  13
  14 \fBchar *\fR\fBgetenv\fR(\fBconst char *\fR\fIname\fR);
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 The \fBgetenv()\fR function searches the environment list (see
  21 \fBenviron\fR(5)) for a string of the form \fIname\fR\fB=\fR\fIvalue\fR and, if
  22 the string is present, returns a pointer to the \fIvalue\fR in the current
  23 environment.
  24 .SH RETURN VALUES
  25 .sp
  26 .LP
  27 If successful, \fBgetenv()\fR returns a pointer to the \fIvalue\fR in the
  28 current environment; otherwise, it returns a null pointer.
  29 .SH USAGE
  30 .sp
  31 .LP
  32 The \fBgetenv()\fR function can be safely called from a multithreaded
  33 application.  Care must be exercised when using both \fBgetenv()\fR and
  34 \fBputenv\fR(3C) in a multithreaded application.  These functions examine and
  35 modify the environment list, which is shared by all threads in an  application.
  36 The system prevents the list from being accessed simultaneously by two
  37 different threads.  It does not, however, prevent two threads from successively
  38 accessing the environment list using  \fBgetenv()\fR or \fBputenv\fR(3C).
  39 .SH ATTRIBUTES
  40 .sp
  41 .LP
  42 See \fBattributes\fR(5) for descriptions of the following attributes:
  43 .sp
  44
  45 .sp
  46 .TS
  47 box;
  48 c | c
  49 l | l .
  50 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  51 _
  52 Interface Stability     Standard
  53 _
  54 MT-Level        Safe
  55 .TE
  56
  57 .SH SEE ALSO
  58 .sp
  59 .LP
  60 \fBexec\fR(2), \fBputenv\fR(3C), \fBattributes\fR(5), \fBenviron\fR(5),
  61 \fBstandards\fR(5)