Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

curl_getenv (3)

Name

curl_getenv - return value for environment name

Synopsis

#include <curl/curl.h>

char *curl_getenv(const char *name);

Description

curl_getenv(3)                  libcurl Manual                  curl_getenv(3)



NAME
       curl_getenv - return value for environment name

SYNOPSIS
       #include <curl/curl.h>

       char *curl_getenv(const char *name);

DESCRIPTION
       curl_getenv() is a portable wrapper for the getenv() function, meant to
       emulate its behavior and provide an identical interface for all operat-
       ing systems libcurl builds on (including win32).

       You must curl_free(3) the returned string when you are done with it.

EXAMPLE
         char *width = curl_getenv("COLUMNS");
         if(width) {
           /* it was set! */
           curl_free(width);
         }

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().

RETURN VALUE
       A  pointer to a null-terminated string or NULL if it failed to find the
       specified name.

NOTE
       Under unix operating systems, there is no point in returning  an  allo-
       cated  memory, although other systems will not work properly if this is
       not done. The unix implementation thus has to suffer slightly from  the
       drawbacks of other systems.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+

SEE ALSO
       getenv(3C),



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source       was       downloaded      from       https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.83.1                 November 26, 2021                curl_getenv(3)