1*f8066b5cSRobert Mustacchi.\" 2*f8066b5cSRobert Mustacchi.\" This file and its contents are supplied under the terms of the 3*f8066b5cSRobert Mustacchi.\" Common Development and Distribution License ("CDDL"), version 1.0. 4*f8066b5cSRobert Mustacchi.\" You may only use this file in accordance with the terms of version 5*f8066b5cSRobert Mustacchi.\" 1.0 of the CDDL. 6*f8066b5cSRobert Mustacchi.\" 7*f8066b5cSRobert Mustacchi.\" A full copy of the text of the CDDL should have accompanied this 8*f8066b5cSRobert Mustacchi.\" source. A copy of the CDDL is also available via the Internet at 9*f8066b5cSRobert Mustacchi.\" http://www.illumos.org/license/CDDL. 10*f8066b5cSRobert Mustacchi.\" 11*f8066b5cSRobert Mustacchi.\" 12*f8066b5cSRobert Mustacchi.\" Copyright (c) 2014, Joyent, Inc. 13*f8066b5cSRobert Mustacchi.\" 14*f8066b5cSRobert Mustacchi.Dd "Dec 20, 2014" 15*f8066b5cSRobert Mustacchi.Dt CLEARENV 3C 16*f8066b5cSRobert Mustacchi.Os 17*f8066b5cSRobert Mustacchi.Sh NAME 18*f8066b5cSRobert Mustacchi.Nm clearenv 19*f8066b5cSRobert Mustacchi.Nd clear environment 20*f8066b5cSRobert Mustacchi.Sh SYNOPSIS 21*f8066b5cSRobert Mustacchi.In stdlib.h 22*f8066b5cSRobert Mustacchi.Ft int 23*f8066b5cSRobert Mustacchi.Fo clearenv 24*f8066b5cSRobert Mustacchi.Fa void 25*f8066b5cSRobert Mustacchi.Fc 26*f8066b5cSRobert Mustacchi.Sh DESCRIPTION 27*f8066b5cSRobert MustacchiThe 28*f8066b5cSRobert Mustacchi.Fn clearenv 29*f8066b5cSRobert Mustacchifunction clears the contents of the environment. All environment variables in 30*f8066b5cSRobert Mustacchithe calling process are removed as though the function 31*f8066b5cSRobert Mustacchi.Xr unsetenv 3C 32*f8066b5cSRobert Mustacchihad been called on every environment variable. Until subsequent calls to 33*f8066b5cSRobert Mustacchi.Xr putenv 3C 34*f8066b5cSRobert Mustacchior 35*f8066b5cSRobert Mustacchi.Xr setenv 3C 36*f8066b5cSRobert Mustacchiare made, calls to 37*f8066b5cSRobert Mustacchi.Xr getenv 3C 38*f8066b5cSRobert Mustacchiwill always return 39*f8066b5cSRobert Mustacchi.Sy NULL . 40*f8066b5cSRobert Mustacchi.Sh RETURN VALUES 41*f8066b5cSRobert MustacchiUpon successful completion, 42*f8066b5cSRobert Mustacchi.Fn clearenv 43*f8066b5cSRobert Mustacchireturns 44*f8066b5cSRobert Mustacchi.Sy 0 . 45*f8066b5cSRobert MustacchiOtherwise, it returns a non-zero value and sets 46*f8066b5cSRobert Mustacchi.Sy errno 47*f8066b5cSRobert Mustacchito indicate the error. At this time, no errors are defined for 48*f8066b5cSRobert Mustacchi.Fn clearenv , 49*f8066b5cSRobert Mustacchiit will always succeed. Portable applications should always check the return 50*f8066b5cSRobert Mustacchivalue of 51*f8066b5cSRobert Mustacchi.Fn clearenv . 52*f8066b5cSRobert Mustacchi.Sh ERRORS 53*f8066b5cSRobert MustacchiNo errors are defined. 54*f8066b5cSRobert Mustacchi.Sh INTERFACE STABILITY 55*f8066b5cSRobert Mustacchi.Sy Committed . 56*f8066b5cSRobert Mustacchi.Sh MT-LEVEL 57*f8066b5cSRobert Mustacchi.Sy Mt-Safe . 58*f8066b5cSRobert Mustacchi.Sh SEE ALSO 59*f8066b5cSRobert Mustacchi.Xr getenv 3C , 60*f8066b5cSRobert Mustacchi.Xr unsetenv 3C , 61*f8066b5cSRobert Mustacchi.Xr setenv 3C , 62*f8066b5cSRobert Mustacchi.Xr attributes 5 , 63*f8066b5cSRobert Mustacchi.Xr environ 5 , 64*f8066b5cSRobert Mustacchi.Xr standards 5 65