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

   1 '\" te
   2 .\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
   3 .\" Portions Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   7 .\"  This notice shall appear on any product containing this material.
   8 .\" 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.
   9 .\" 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.
  10 .\" 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]
  11 .TH SETENV 3C "Mar 31, 2002"
  12 .SH NAME
  13 setenv \- add or change environment variable
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 #include <stdlib.h>
  18
  19 \fBint\fR \fBsetenv\fR(\fBconst char *\fR\fIenvname\fR, \fBconst char *\fR\fIenvval\fR,
  20      \fBint\fR \fIoverwrite\fR);
  21 .fi
  22
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 The \fBsetenv()\fR function updates or adds a variable in the environment of
  27 the calling process.  The \fIenvname\fR argument points to a string containing
  28 the name of an environment variable to be added or altered. The environment
  29 variable is set to the value to which \fIenvval\fR points. The function fails
  30 if \fIenvname\fR points to a string which contains an '=' character. If the
  31 environment variable named by \fIenvname\fR already exists and the value of
  32 \fIoverwrite\fR is non-zero, the function returns successfully and the
  33 environment is updated. If the environment variable named by \fIenvname\fR
  34 already exists and the value of \fIoverwrite\fR is zero, the function returns
  35 successfully and the environment remains unchanged.
  36 .sp
  37 .LP
  38 If the application modifies \fIenviron\fR or the pointers to which it points,
  39 the behavior of \fBsetenv()\fR is undefined. The \fBsetenv()\fR function
  40 updates the list of pointers to which \fIenviron\fR points.
  41 .sp
  42 .LP
  43 The strings described by \fIenvname\fR and \fIenvval\fR are copied by this
  44 function.
  45 .SH RETURN VALUES
  46 .sp
  47 .LP
  48 Upon successful completion, 0 is returned. Otherwise, -1 is returned,
  49 \fBerrno\fR set to indicate the error, and the environment is left unchanged.
  50 .SH ERRORS
  51 .sp
  52 .LP
  53 The \fBsetenv()\fR function will fail if:
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBEINVAL\fR\fR
  58 .ad
  59 .RS 10n
  60 The \fIenvname\fR argument is a null pointer, points to an empty string, or
  61 points to a string containing an '=' character.
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fBENOMEM\fR\fR
  68 .ad
  69 .RS 10n
  70 Insufficient memory was available to add a variable or its value to the
  71 environment.
  72 .RE
  73
  74 .SH ATTRIBUTES
  75 .sp
  76 .LP
  77 See \fBattributes\fR(5) for descriptions of the following attributes:
  78 .sp
  79
  80 .sp
  81 .TS
  82 box;
  83 c | c
  84 l | l .
  85 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  86 _
  87 Interface Stability     Standard
  88 _
  89 MT-Level        MT-Safe
  90 .TE
  91
  92 .SH SEE ALSO
  93 .sp
  94 .LP
  95 \fBgetenv\fR(3C), \fBunsetenv\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)