usr/src/man/man3c/unsetenv.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) 2003, 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 UNSETENV 3C "Dec 20, 2014"
  12 .SH NAME
  13 unsetenv \- remove an environment variable
  14 .SH SYNOPSIS
  15 .LP
  16 .nf
  17 #include <stdlib.h>
  18
  19 \fBint\fR \fBunsetenv\fR(\fBconst char *\fR\fIname\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .LP
  24 The \fBunsetenv()\fR function removes an environment variable from the
  25 environment of the calling process. The \fIname\fR argument points to a string
  26 that is the name of the variable to be removed. The named argument cannot
  27 contain an '=' character. If the named variable does not exist in the current
  28 environment, the environment is unchanged and the function is considered to
  29 have completed successfully.
  30 .sp
  31 .LP
  32 If the application modifies \fIenviron\fR or the pointers to which it points,
  33 the behavior of \fBunsetenv()\fR is undefined. The \fBunsetenv()\fR function
  34 updates the list of pointers to which \fIenviron\fR points.
  35 .SH RETURN VALUES
  36 .LP
  37 Upon successful completion, 0 is returned. Otherwise, -1 is returned,
  38 \fBerrno\fR set to indicate the error, and the environment is left unchanged.
  39 .SH ERRORS
  40 .LP
  41 The \fBunsetenv()\fR function will fail if:
  42 .sp
  43 .ne 2
  44 .na
  45 \fB\fBEINVAL\fR\fR
  46 .ad
  47 .RS 10n
  48 The \fIname\fR argument is a null pointer, points to an empty string, or points
  49 to a string containing an '=' character.
  50 .RE
  51
  52 .SH ATTRIBUTES
  53 .LP
  54 See \fBattributes\fR(5) for descriptions of the following attributes:
  55 .sp
  56
  57 .sp
  58 .TS
  59 box;
  60 c | c
  61 l | l .
  62 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  63 _
  64 Interface Stability     Standard
  65 _
  66 MT-Level        MT-Safe
  67 .TE
  68
  69 .SH SEE ALSO
  70 .LP
  71 \fBclearenv\fR(3C), \fBgetenv\fR(3C), \fBsetenv\fR(3C), \fBattributes\fR(5),
  72 \fBstandards\fR(5)