1 .\" **************************************************************************
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
8 .\" * Copyright (C) 1998 - 2011, Daniel Stenberg, <daniel@haxx.se>, et al.
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at http://curl.haxx.se/docs/copyright.html.
14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 .\" * copies of the Software, and permit persons to whom the Software is
16 .\" * furnished to do so, under the terms of the COPYING file.
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
21 .\" **************************************************************************
22 .TH curl_getenv 3 "30 April 2004" "libcurl 7.12" "libcurl Manual"
24 curl_getenv - return value for environment name
26 .B #include <curl/curl.h>
28 .BI "char *curl_getenv(const char *" name ");"
31 curl_getenv() is a portable wrapper for the getenv() function, meant to
32 emulate its behaviour and provide an identical interface for all operating
33 systems libcurl builds on (including win32).
35 This function will be removed from the public libcurl API in a near future. It
36 will instead be made "available" by source code access only, and then as
39 If successful, curl_getenv() returns a pointer to the value of the specified
40 environment. The memory it refers to is malloc()ed so the application must
41 free() this when the data is no longer needed. When \fIcurl_getenv(3)\fP fails
42 to find the specified name, it returns a null pointer.
44 Under unix operating systems, there isn't any point in returning an allocated
45 memory, although other systems won't work properly if this isn't done. The
46 unix implementation thus has to suffer slightly from the drawbacks of other