share/man/man3c/unsetenv.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) 2003, Sun Microsystems, Inc. All Rights Reserved.
  45 .\"
  46 .TH UNSETENV 3C "Dec 20, 2014"
  47 .SH NAME
  48 unsetenv \- remove an environment variable
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <stdlib.h>
  53
  54 \fBint\fR \fBunsetenv\fR(\fBconst char *\fR\fIname\fR);
  55 .fi
  56
  57 .SH DESCRIPTION
  58 .LP
  59 The \fBunsetenv()\fR function removes an environment variable from the
  60 environment of the calling process. The \fIname\fR argument points to a string
  61 that is the name of the variable to be removed. The named argument cannot
  62 contain an '=' character. If the named variable does not exist in the current
  63 environment, the environment is unchanged and the function is considered to
  64 have completed successfully.
  65 .sp
  66 .LP
  67 If the application modifies \fIenviron\fR or the pointers to which it points,
  68 the behavior of \fBunsetenv()\fR is undefined. The \fBunsetenv()\fR function
  69 updates the list of pointers to which \fIenviron\fR points.
  70 .SH RETURN VALUES
  71 .LP
  72 Upon successful completion, 0 is returned. Otherwise, -1 is returned,
  73 \fBerrno\fR set to indicate the error, and the environment is left unchanged.
  74 .SH ERRORS
  75 .LP
  76 The \fBunsetenv()\fR function will fail if:
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fBEINVAL\fR\fR
  81 .ad
  82 .RS 10n
  83 The \fIname\fR argument is a null pointer, points to an empty string, or points
  84 to a string containing an '=' character.
  85 .RE
  86
  87 .SH ATTRIBUTES
  88 .LP
  89 See \fBattributes\fR(5) for descriptions of the following attributes:
  90 .sp
  91
  92 .sp
  93 .TS
  94 box;
  95 c | c
  96 l | l .
  97 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  98 _
  99 Interface Stability     Standard
 100 _
 101 MT-Level        MT-Safe
 102 .TE
 103
 104 .SH SEE ALSO
 105 .LP
 106 \fBclearenv\fR(3C), \fBgetenv\fR(3C), \fBsetenv\fR(3C), \fBattributes\fR(5),
 107 \fBstandards\fR(5)