xref: /aosp_15_r20/external/curl/docs/libcurl/curl_getenv.md (revision 6236dae45794135f37c4eb022389c904c8b0090d)
1*6236dae4SAndroid Build Coastguard Worker---
2*6236dae4SAndroid Build Coastguard Workerc: Copyright (C) Daniel Stenberg, <[email protected]>, et al.
3*6236dae4SAndroid Build Coastguard WorkerSPDX-License-Identifier: curl
4*6236dae4SAndroid Build Coastguard WorkerTitle: curl_getenv
5*6236dae4SAndroid Build Coastguard WorkerSection: 3
6*6236dae4SAndroid Build Coastguard WorkerSource: libcurl
7*6236dae4SAndroid Build Coastguard WorkerSee-also:
8*6236dae4SAndroid Build Coastguard Worker  - getenv (3C)
9*6236dae4SAndroid Build Coastguard WorkerProtocol:
10*6236dae4SAndroid Build Coastguard Worker  - All
11*6236dae4SAndroid Build Coastguard WorkerAdded-in: 7.1
12*6236dae4SAndroid Build Coastguard Worker---
13*6236dae4SAndroid Build Coastguard Worker
14*6236dae4SAndroid Build Coastguard Worker# NAME
15*6236dae4SAndroid Build Coastguard Worker
16*6236dae4SAndroid Build Coastguard Workercurl_getenv - return value for environment name
17*6236dae4SAndroid Build Coastguard Worker
18*6236dae4SAndroid Build Coastguard Worker# SYNOPSIS
19*6236dae4SAndroid Build Coastguard Worker
20*6236dae4SAndroid Build Coastguard Worker~~~c
21*6236dae4SAndroid Build Coastguard Worker#include <curl/curl.h>
22*6236dae4SAndroid Build Coastguard Worker
23*6236dae4SAndroid Build Coastguard Workerchar *curl_getenv(const char *name);
24*6236dae4SAndroid Build Coastguard Worker~~~
25*6236dae4SAndroid Build Coastguard Worker
26*6236dae4SAndroid Build Coastguard Worker# DESCRIPTION
27*6236dae4SAndroid Build Coastguard Worker
28*6236dae4SAndroid Build Coastguard Workercurl_getenv() is a portable wrapper for the getenv() function, meant to
29*6236dae4SAndroid Build Coastguard Workeremulate its behavior and provide an identical interface for all operating
30*6236dae4SAndroid Build Coastguard Workersystems libcurl builds on (including Windows).
31*6236dae4SAndroid Build Coastguard Worker
32*6236dae4SAndroid Build Coastguard WorkerYou must curl_free(3) the returned string when you are done with it.
33*6236dae4SAndroid Build Coastguard Worker
34*6236dae4SAndroid Build Coastguard Worker# %PROTOCOLS%
35*6236dae4SAndroid Build Coastguard Worker
36*6236dae4SAndroid Build Coastguard Worker# EXAMPLE
37*6236dae4SAndroid Build Coastguard Worker
38*6236dae4SAndroid Build Coastguard Worker~~~c
39*6236dae4SAndroid Build Coastguard Workerint main(void)
40*6236dae4SAndroid Build Coastguard Worker{
41*6236dae4SAndroid Build Coastguard Worker  char *width = curl_getenv("COLUMNS");
42*6236dae4SAndroid Build Coastguard Worker  if(width) {
43*6236dae4SAndroid Build Coastguard Worker    /* it was set */
44*6236dae4SAndroid Build Coastguard Worker    curl_free(width);
45*6236dae4SAndroid Build Coastguard Worker  }
46*6236dae4SAndroid Build Coastguard Worker}
47*6236dae4SAndroid Build Coastguard Worker~~~
48*6236dae4SAndroid Build Coastguard Worker
49*6236dae4SAndroid Build Coastguard Worker# %AVAILABILITY%
50*6236dae4SAndroid Build Coastguard Worker
51*6236dae4SAndroid Build Coastguard Worker# RETURN VALUE
52*6236dae4SAndroid Build Coastguard Worker
53*6236dae4SAndroid Build Coastguard WorkerA pointer to a null-terminated string or NULL if it failed to find the
54*6236dae4SAndroid Build Coastguard Workerspecified name.
55*6236dae4SAndroid Build Coastguard Worker
56*6236dae4SAndroid Build Coastguard Worker# NOTE
57*6236dae4SAndroid Build Coastguard Worker
58*6236dae4SAndroid Build Coastguard WorkerUnder Unix operating systems, there is no point in returning an allocated
59*6236dae4SAndroid Build Coastguard Workermemory, although other systems does not work properly if this is not done. The
60*6236dae4SAndroid Build Coastguard WorkerUnix implementation thus suffers slightly from the drawbacks of other systems.
61