From 89b9271284be1a4e3e3053d7bc12f9bbf8145b06 Mon Sep 17 00:00:00 2001 From: Robert Mustacchi Date: Fri, 19 Dec 2014 23:24:17 +0000 Subject: 3827 clearenv() needs a manpage Reviewed by: Jerry Jelinek Approved by: Richard Lowe --- usr/src/man/man3c/clearenv.3c | 64 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 usr/src/man/man3c/clearenv.3c (limited to 'usr/src/man/man3c/clearenv.3c') diff --git a/usr/src/man/man3c/clearenv.3c b/usr/src/man/man3c/clearenv.3c new file mode 100644 index 0000000000..1bf5cbde17 --- /dev/null +++ b/usr/src/man/man3c/clearenv.3c @@ -0,0 +1,64 @@ +.\" +.\" This file and its contents are supplied under the terms of the +.\" Common Development and Distribution License ("CDDL"), version 1.0. +.\" You may only use this file in accordance with the terms of version +.\" 1.0 of the CDDL. +.\" +.\" A full copy of the text of the CDDL should have accompanied this +.\" source. A copy of the CDDL is also available via the Internet at +.\" http://www.illumos.org/license/CDDL. +.\" +.\" +.\" Copyright (c) 2014, Joyent, Inc. +.\" +.Dd "Dec 20, 2014" +.Dt CLEARENV 3C +.Os +.Sh NAME +.Nm clearenv +.Nd clear environment +.Sh SYNOPSIS +.In stdlib.h +.Ft int +.Fo clearenv +.Fa void +.Fc +.Sh DESCRIPTION +The +.Fn clearenv +function clears the contents of the environment. All environment variables in +the calling process are removed as though the function +.Xr unsetenv 3C +had been called on every environment variable. Until subsequent calls to +.Xr putenv 3C +or +.Xr setenv 3C +are made, calls to +.Xr getenv 3C +will always return +.Sy NULL . +.Sh RETURN VALUES +Upon successful completion, +.Fn clearenv +returns +.Sy 0 . +Otherwise, it returns a non-zero value and sets +.Sy errno +to indicate the error. At this time, no errors are defined for +.Fn clearenv , +it will always succeed. Portable applications should always check the return +value of +.Fn clearenv . +.Sh ERRORS +No errors are defined. +.Sh INTERFACE STABILITY +.Sy Committed . +.Sh MT-LEVEL +.Sy Mt-Safe . +.Sh SEE ALSO +.Xr getenv 3C , +.Xr unsetenv 3C , +.Xr setenv 3C , +.Xr attributes 5 , +.Xr environ 5 , +.Xr standards 5 -- cgit v1.2.3