2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
3 .\" permission to reproduce portions of its copyrighted documentation.
4 .\" Original documentation from The Open Group can be obtained online at
5 .\" http://www.opengroup.org/bookstore/.
7 .\" The Institute of Electrical and Electronics Engineers and The Open
8 .\" Group, have given us permission to reprint portions of their
11 .\" In the following statement, the phrase ``this text'' refers to portions
12 .\" of the system documentation.
14 .\" Portions of this text are reprinted and reproduced in electronic form
15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
16 .\" Standard for Information Technology -- Portable Operating System
17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
19 .\" Engineers, Inc and The Open Group. In the event of any discrepancy
20 .\" between these versions and the original IEEE and The Open Group
21 .\" Standard, the original IEEE and The Open Group Standard is the referee
22 .\" document. The original Standard can be obtained online at
23 .\" http://www.opengroup.org/unix/online.html.
25 .\" This notice shall appear on any product containing this material.
27 .\" The contents of this file are subject to the terms of the
28 .\" Common Development and Distribution License (the "License").
29 .\" You may not use this file except in compliance with the License.
31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
32 .\" or http://www.opensolaris.org/os/licensing.
33 .\" See the License for the specific language governing permissions
34 .\" and limitations under the License.
36 .\" When distributing Covered Code, include this CDDL HEADER in each
37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
38 .\" If applicable, add the following below this CDDL HEADER, with the
39 .\" fields enclosed by brackets "[]" replaced with your own identifying
40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
43 .\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
44 .\" Portions Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
46 .TH SETENV 3C "Mar 31, 2002"
48 setenv \- add or change environment variable
54 \fBint\fR \fBsetenv\fR(\fBconst char *\fR\fIenvname\fR, \fBconst char *\fR\fIenvval\fR,
55 \fBint\fR \fIoverwrite\fR);
61 The \fBsetenv()\fR function updates or adds a variable in the environment of
62 the calling process. The \fIenvname\fR argument points to a string containing
63 the name of an environment variable to be added or altered. The environment
64 variable is set to the value to which \fIenvval\fR points. The function fails
65 if \fIenvname\fR points to a string which contains an '=' character. If the
66 environment variable named by \fIenvname\fR already exists and the value of
67 \fIoverwrite\fR is non-zero, the function returns successfully and the
68 environment is updated. If the environment variable named by \fIenvname\fR
69 already exists and the value of \fIoverwrite\fR is zero, the function returns
70 successfully and the environment remains unchanged.
73 If the application modifies \fIenviron\fR or the pointers to which it points,
74 the behavior of \fBsetenv()\fR is undefined. The \fBsetenv()\fR function
75 updates the list of pointers to which \fIenviron\fR points.
78 The strings described by \fIenvname\fR and \fIenvval\fR are copied by this
83 Upon successful completion, 0 is returned. Otherwise, -1 is returned,
84 \fBerrno\fR set to indicate the error, and the environment is left unchanged.
88 The \fBsetenv()\fR function will fail if:
95 The \fIenvname\fR argument is a null pointer, points to an empty string, or
96 points to a string containing an '=' character.
105 Insufficient memory was available to add a variable or its value to the
112 See \fBattributes\fR(5) for descriptions of the following attributes:
120 ATTRIBUTE TYPE ATTRIBUTE VALUE
122 Interface Stability Standard
130 \fBgetenv\fR(3C), \fBunsetenv\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)