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