share/man/man3c/setenv.3c

   1 .\"
   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/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  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.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  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.
  30 .\"
  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.
  35 .\"
  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]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
  45 .\"
  46 .TH SETENV 3C "Mar 31, 2002"
  47 .SH NAME
  48 setenv \- add or change environment variable
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <stdlib.h>
  53
  54 \fBint\fR \fBsetenv\fR(\fBconst char *\fR\fIenvname\fR, \fBconst char *\fR\fIenvval\fR,
  55      \fBint\fR \fIoverwrite\fR);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  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.
  71 .sp
  72 .LP
  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.
  76 .sp
  77 .LP
  78 The strings described by \fIenvname\fR and \fIenvval\fR are copied by this
  79 function.
  80 .SH RETURN VALUES
  81 .sp
  82 .LP
  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.
  85 .SH ERRORS
  86 .sp
  87 .LP
  88 The \fBsetenv()\fR function will fail if:
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fBEINVAL\fR\fR
  93 .ad
  94 .RS 10n
  95 The \fIenvname\fR argument is a null pointer, points to an empty string, or
  96 points to a string containing an '=' character.
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fB\fBENOMEM\fR\fR
 103 .ad
 104 .RS 10n
 105 Insufficient memory was available to add a variable or its value to the
 106 environment.
 107 .RE
 108
 109 .SH ATTRIBUTES
 110 .sp
 111 .LP
 112 See \fBattributes\fR(5) for descriptions of the following attributes:
 113 .sp
 114
 115 .sp
 116 .TS
 117 box;
 118 c | c
 119 l | l .
 120 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 121 _
 122 Interface Stability     Standard
 123 _
 124 MT-Level        MT-Safe
 125 .TE
 126
 127 .SH SEE ALSO
 128 .sp
 129 .LP
 130 \fBgetenv\fR(3C), \fBunsetenv\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)