2024-03-15 20:55:33 -06:00
|
|
|
.\" generated by cd2nroff 0.1 from curl_getenv.md
|
2024-12-25 11:28:33 -07:00
|
|
|
.TH curl_getenv 3 "2024-12-25" libcurl
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH NAME
|
|
|
|
|
curl_getenv \- return value for environment name
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
char *curl_getenv(const char *name);
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
curl_getenv() is a portable wrapper for the getenv() function, meant to
|
|
|
|
|
emulate its behavior and provide an identical interface for all operating
|
2024-09-15 18:10:01 -06:00
|
|
|
systems libcurl builds on (including Windows).
|
2024-03-15 20:55:33 -06:00
|
|
|
|
|
|
|
|
You must \fIcurl_free(3)\fP the returned string when you are done with it.
|
2024-03-30 12:28:04 -06:00
|
|
|
.SH PROTOCOLS
|
2024-07-29 18:00:04 -06:00
|
|
|
This functionality affects all supported protocols
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH EXAMPLE
|
|
|
|
|
.nf
|
|
|
|
|
int main(void)
|
|
|
|
|
{
|
|
|
|
|
char *width = curl_getenv("COLUMNS");
|
|
|
|
|
if(width) {
|
2024-11-09 21:03:25 -07:00
|
|
|
/* it was set */
|
2024-03-15 20:55:33 -06:00
|
|
|
curl_free(width);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
.fi
|
|
|
|
|
.SH AVAILABILITY
|
2024-07-29 18:00:04 -06:00
|
|
|
Added in curl 7.1
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH RETURN VALUE
|
|
|
|
|
A pointer to a null\-terminated string or NULL if it failed to find the
|
|
|
|
|
specified name.
|
|
|
|
|
.SH NOTE
|
2024-09-15 18:10:01 -06:00
|
|
|
Under Unix operating systems, there is no point in returning an allocated
|
2024-03-15 20:55:33 -06:00
|
|
|
memory, although other systems does not work properly if this is not done. The
|
2024-09-15 18:10:01 -06:00
|
|
|
Unix implementation thus suffers slightly from the drawbacks of other systems.
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR getenv (3C)
|
