curl/docs/libcurl/curl_getenv.md
Daniel Stenberg 8c1d9378ac
curldown: make 'added-in:' a mandatory header field
- generate AVAILABILITY manpage sections automatically - for consistent
  wording

- allows us to double-check against other documumentation (symbols-in-versions
  etc)

- enables proper automation/scripting based on this data

- lots of them were wrong or missing in the manpages

- several of them repeated (sometimes mismatching) backend support info

Add test 1488 to verify "added-in" version numbers against
symbols-in-versions.

Closes #14217
2024-07-18 18:04:09 +02:00

1.1 KiB

c SPDX-License-Identifier Title Section Source See-also Protocol Added-in
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. curl curl_getenv 3 libcurl
getenv (3C)
All
7.1

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

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

EXAMPLE

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

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.