curl_getenv

Section: C Library Functions (3)
Updated: 202-0-19
Index Return to Main Contents

---

 

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 operating systems libcurl builds on (including Windows).

You must curl_free(3) the returned string when you are done with it and, although not constrained by its type, it may not be altered.  

PROTOCOLS

This functionality affects all supported protocols  

EXAMPLE

int main(void)
{
  char *width = curl_getenv("COLUMNS");
  if(width) {
    /* it was set */
    curl_free(width);
  }
}

 

AVAILABILITY

Added in curl 7.1  

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 allocated memory, although other systems does not work properly if this is not done. The Unix implementation thus suffers slightly from the drawbacks of other systems.  

SEE ALSO

getenv(3C)

---

 

Index

NAME

SYNOPSIS

DESCRIPTION

PROTOCOLS

EXAMPLE

AVAILABILITY

RETURN VALUE

NOTE

SEE ALSO