2002-03-04 05:09:48 -05:00
|
|
|
.\" $Id$
|
|
|
|
|
.\"
|
2004-04-30 04:38:08 -04:00
|
|
|
.TH curl_getenv 3 "30 April 2004" "libcurl 7.12" "libcurl Manual"
|
2002-03-04 05:09:48 -05:00
|
|
|
.SH NAME
|
|
|
|
|
curl_getenv - return value for environment name
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.B #include <curl/curl.h>
|
|
|
|
|
.sp
|
2004-02-27 10:34:06 -05:00
|
|
|
.BI "char *curl_getenv(const char *" name ");"
|
2002-03-04 05:09:48 -05:00
|
|
|
.ad
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
curl_getenv() is a portable wrapper for the getenv() function, meant to
|
|
|
|
|
emulate its behaviour and provide an identical interface for all operating
|
|
|
|
|
systems libcurl builds on (including win32).
|
2004-04-30 04:38:08 -04:00
|
|
|
.SH AVAILABILITY
|
|
|
|
|
This function will be removed from the public libcurl API in a near future. It
|
|
|
|
|
will instead be made "available" by source code access only, and then as
|
|
|
|
|
curlx_getenv().
|
2002-03-04 05:09:48 -05:00
|
|
|
.SH RETURN VALUE
|
|
|
|
|
If successful, curl_getenv() returns a pointer to the value of the specified
|
|
|
|
|
environment. The memory it refers to is malloc()ed why the application must
|
|
|
|
|
free() this when the data has completed to serve its purpose. When
|
2004-02-27 10:34:06 -05:00
|
|
|
.I curl_getenv(3)
|
2002-03-04 05:09:48 -05:00
|
|
|
fails to find the specified name, it returns a null pointer.
|
|
|
|
|
.SH NOTE
|
|
|
|
|
Under unix operating systems, there isn't any point in returning an allocated
|
|
|
|
|
memory, although other systems won't work properly if this isn't done. The
|
|
|
|
|
unix implementation thus have to suffer slightly from the drawbacks of other
|
|
|
|
|
systems.
|
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
|
.BR getenv "(3C), "
|
