docs/libcurl/curl_getenv.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2011, Daniel Stenberg, <daniel@haxx.se>, et al.
   9 .\" *
  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 https://curl.haxx.se/docs/copyright.html.
  13 .\" *
  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.
  17 .\" *
  18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19 .\" * KIND, either express or implied.
  20 .\" *
  21 .\" **************************************************************************
  22 .TH curl_getenv 3 "February 03, 2016" "libcurl 7.59.0" "libcurl Manual"
  23
  24 .SH NAME
  25 curl_getenv - return value for environment name
  26 .SH SYNOPSIS
  27 .B #include <curl/curl.h>
  28 .sp
  29 .BI "char *curl_getenv(const char *" name ");"
  30 .ad
  31 .SH DESCRIPTION
  32 curl_getenv() is a portable wrapper for the getenv() function, meant to
  33 emulate its behaviour and provide an identical interface for all operating
  34 systems libcurl builds on (including win32).
  35 .SH AVAILABILITY
  36 This function will be removed from the public libcurl API in a near future. It
  37 will instead be made "available" by source code access only, and then as
  38 curlx_getenv().
  39 .SH RETURN VALUE
  40 If successful, curl_getenv() returns a pointer to the value of the specified
  41 environment. The memory it refers to is malloc()ed so the application must
  42 free() this when the data is no longer needed. When \fIcurl_getenv(3)\fP fails
  43 to find the specified name, it returns a null pointer.
  44 .SH NOTE
  45 Under unix operating systems, there isn't any point in returning an allocated
  46 memory, although other systems won't work properly if this isn't done. The
  47 unix implementation thus has to suffer slightly from the drawbacks of other
  48 systems.
  49 .SH "SEE ALSO"
  50 .BR getenv "(3C), "