curl/docs/libcurl/curl_getenv.md
Viktor Szakats 3040971d12
GHA: silence proselint warnings and an error
Fix new issues found by `proselint`.

Also:
- silence this technical warning:
  ```
  :0: DeprecationWarning: /home/runner/.proselintrc was found instead of a JSON file. Rename to /home/runner/.proselintrc.json.
  ```
- fix an input filename.
  `proselints` fails now if an input file is missing.

Reported-by: Jay Satiro
Bug: https://github.com/curl/curl/pull/15291#issuecomment-2410505100
Closes #15293
2024-10-15 16:44:17 +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 Windows).

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

%PROTOCOLS%

EXAMPLE

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

%AVAILABILITY%

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.