CMakeLua/Utilities/cmcurl-7.19.0/docs/libcurl/curl_getenv.3

   1 .\" $Id: curl_getenv.3,v 1.1.1.1 2008-09-23 16:32:05 hoffman Exp $
   2 .\"
   3 .TH curl_getenv 3 "30 April 2004" "libcurl 7.12" "libcurl Manual"
   4 .SH NAME
   5 curl_getenv - return value for environment name
   6 .SH SYNOPSIS
   7 .B #include <curl/curl.h>
   8 .sp
   9 .BI "char *curl_getenv(const char *" name ");"
  10 .ad
  11 .SH DESCRIPTION
  12 curl_getenv() is a portable wrapper for the getenv() function, meant to
  13 emulate its behaviour and provide an identical interface for all operating
  14 systems libcurl builds on (including win32).
  15 .SH AVAILABILITY
  16 This function will be removed from the public libcurl API in a near future. It
  17 will instead be made "available" by source code access only, and then as
  18 curlx_getenv().
  19 .SH RETURN VALUE
  20 If successful, curl_getenv() returns a pointer to the value of the specified
  21 environment. The memory it refers to is malloc()ed so the application must
  22 free() this when the data is no longer needed. When \fIcurl_getenv(3)\fP fails
  23 to find the specified name, it returns a null pointer.
  24 .SH NOTE
  25 Under unix operating systems, there isn't any point in returning an allocated
  26 memory, although other systems won't work properly if this isn't done. The
  27 unix implementation thus have to suffer slightly from the drawbacks of other
  28 systems.
  29 .SH "SEE ALSO"
  30 .BR getenv "(3C), "