Browse Source

Correctly document the return value of getenv(3)

From Ben Cornett (ben (at) lantern.is)
OPENBSD_5_6
guenther 10 years ago
parent
commit
e004b9b14e
1 changed files with 8 additions and 6 deletions
  1. +8
    -6
      src/lib/libc/stdlib/getenv.3

+ 8
- 6
src/lib/libc/stdlib/getenv.3 View File

@ -29,9 +29,9 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE. .\" SUCH DAMAGE.
.\" .\"
.\" $OpenBSD: getenv.3,v 1.19 2013/06/05 03:39:23 tedu Exp $
.\" $OpenBSD: getenv.3,v 1.20 2014/04/21 08:46:59 guenther Exp $
.\" .\"
.Dd $Mdocdate: June 5 2013 $
.Dd $Mdocdate: April 21 2014 $
.Dt GETENV 3 .Dt GETENV 3
.Os .Os
.Sh NAME .Sh NAME
@ -102,11 +102,13 @@ function deletes all instances of the variable name pointed to by
.Fa name .Fa name
from the list. from the list.
.Sh RETURN VALUES .Sh RETURN VALUES
These functions
return zero if successful; otherwise the global variable
.Va errno
is set to indicate the error and \-1 is returned.
.Rv -std putenv setenv unsetenv
.Pp .Pp
The
.Fn getenv
function returns a pointer to the requested value, or
.Dv NULL
if it could not be found.
If If
.Fn getenv .Fn getenv
is successful, the string returned should be considered read-only. is successful, the string returned should be considered read-only.


Loading…
Cancel
Save