xref: /titanic_50/usr/src/man/man3c/clearenv.3c (revision 3a005aada8ac0e291c13cbc488ba9ae1473f0a96)
189b92712SRobert Mustacchi.\"
289b92712SRobert Mustacchi.\" This file and its contents are supplied under the terms of the
389b92712SRobert Mustacchi.\" Common Development and Distribution License ("CDDL"), version 1.0.
489b92712SRobert Mustacchi.\" You may only use this file in accordance with the terms of version
589b92712SRobert Mustacchi.\" 1.0 of the CDDL.
689b92712SRobert Mustacchi.\"
789b92712SRobert Mustacchi.\" A full copy of the text of the CDDL should have accompanied this
889b92712SRobert Mustacchi.\" source.  A copy of the CDDL is also available via the Internet at
989b92712SRobert Mustacchi.\" http://www.illumos.org/license/CDDL.
1089b92712SRobert Mustacchi.\"
1189b92712SRobert Mustacchi.\"
1289b92712SRobert Mustacchi.\" Copyright (c) 2014, Joyent, Inc.
1389b92712SRobert Mustacchi.\"
1489b92712SRobert Mustacchi.Dd "Dec 20, 2014"
1589b92712SRobert Mustacchi.Dt CLEARENV 3C
1689b92712SRobert Mustacchi.Os
1789b92712SRobert Mustacchi.Sh NAME
1889b92712SRobert Mustacchi.Nm clearenv
1989b92712SRobert Mustacchi.Nd clear environment
2089b92712SRobert Mustacchi.Sh SYNOPSIS
2189b92712SRobert Mustacchi.In stdlib.h
2289b92712SRobert Mustacchi.Ft int
2389b92712SRobert Mustacchi.Fo clearenv
2489b92712SRobert Mustacchi.Fa void
2589b92712SRobert Mustacchi.Fc
2689b92712SRobert Mustacchi.Sh DESCRIPTION
2789b92712SRobert MustacchiThe
2889b92712SRobert Mustacchi.Fn clearenv
2989b92712SRobert Mustacchifunction clears the contents of the environment. All environment variables in
3089b92712SRobert Mustacchithe calling process are removed as though the function
3189b92712SRobert Mustacchi.Xr unsetenv 3C
3289b92712SRobert Mustacchihad been called on every environment variable. Until subsequent calls to
3389b92712SRobert Mustacchi.Xr putenv 3C
3489b92712SRobert Mustacchior
3589b92712SRobert Mustacchi.Xr setenv 3C
3689b92712SRobert Mustacchiare made, calls to
3789b92712SRobert Mustacchi.Xr getenv 3C
3889b92712SRobert Mustacchiwill always return
3989b92712SRobert Mustacchi.Sy NULL .
4089b92712SRobert Mustacchi.Sh RETURN VALUES
4189b92712SRobert MustacchiUpon successful completion,
4289b92712SRobert Mustacchi.Fn clearenv
4389b92712SRobert Mustacchireturns
4489b92712SRobert Mustacchi.Sy 0 .
4589b92712SRobert MustacchiOtherwise, it returns a non-zero value and sets
4689b92712SRobert Mustacchi.Sy errno
4789b92712SRobert Mustacchito indicate the error. At this time, no errors are defined for
4889b92712SRobert Mustacchi.Fn clearenv ,
4989b92712SRobert Mustacchiit will always succeed. Portable applications should always check the return
5089b92712SRobert Mustacchivalue of
5189b92712SRobert Mustacchi.Fn clearenv .
5289b92712SRobert Mustacchi.Sh ERRORS
5389b92712SRobert MustacchiNo errors are defined.
5489b92712SRobert Mustacchi.Sh INTERFACE STABILITY
5589b92712SRobert Mustacchi.Sy Committed .
5689b92712SRobert Mustacchi.Sh MT-LEVEL
5789b92712SRobert Mustacchi.Sy Mt-Safe .
5889b92712SRobert Mustacchi.Sh SEE ALSO
5989b92712SRobert Mustacchi.Xr getenv 3C ,
6089b92712SRobert Mustacchi.Xr setenv 3C ,
61*3a005aadSYuri Pankov.Xr unsetenv 3C ,
6289b92712SRobert Mustacchi.Xr attributes 5 ,
6389b92712SRobert Mustacchi.Xr environ 5 ,
6489b92712SRobert Mustacchi.Xr standards 5
65