Resync
[CMakeLuaTailorHgBridge.git] / CMakeLua / Utilities / cmcurl-7.19.0 / docs / libcurl / curl_getenv.html
blob351a512d90909d19c0a087c6747bb1ce9be81886
1 <html><head>
2 <title>curl_getenv man page</title>
3 <meta name="generator" content="roffit 0.7">
4 <STYLE type="text/css">
5 P.level0 {
6 padding-left: 2em;
9 P.level1 {
10 padding-left: 4em;
13 P.level2 {
14 padding-left: 6em;
17 span.emphasis {
18 font-style: italic;
21 span.bold {
22 font-weight: bold;
25 span.manpage {
26 font-weight: bold;
29 h2.nroffsh {
30 background-color: #e0e0e0;
33 span.nroffip {
34 font-weight: bold;
35 font-size: 120%;
36 font-family: monospace;
39 p.roffit {
40 text-align: center;
41 font-size: 80%;
43 </STYLE>
44 </head><body>
46 <p class="level0"><a name="NAME"></a><h2 class="nroffsh">NAME</h2>
47 <p class="level0">curl_getenv - return value for environment name <a name="SYNOPSIS"></a><h2 class="nroffsh">SYNOPSIS</h2>
48 <p class="level0"><span Class="bold">#include &lt;curl/curl.h&gt;</span>
49 <p class="level0"><span Class="bold">char *curl_getenv(const char * name );</span>
50 <p class="level0"><a name="DESCRIPTION"></a><h2 class="nroffsh">DESCRIPTION</h2>
51 <p class="level0">curl_getenv() is a portable wrapper for the getenv() function, meant to emulate its behaviour and provide an identical interface for all operating systems libcurl builds on (including win32). <a name="AVAILABILITY"></a><h2 class="nroffsh">AVAILABILITY</h2>
52 <p class="level0">This function will be removed from the public libcurl API in a near future. It will instead be made "available" by source code access only, and then as curlx_getenv(). <a name="RETURN"></a><h2 class="nroffsh">RETURN VALUE</h2>
53 <p class="level0">If successful, curl_getenv() returns a pointer to the value of the specified environment. The memory it refers to is malloc()ed so the application must free() this when the data is no longer needed. When <a class="emphasis" href="./curl_getenv.html">curl_getenv(3)</a> fails to find the specified name, it returns a null pointer. <a name="NOTE"></a><h2 class="nroffsh">NOTE</h2>
54 <p class="level0">Under unix operating systems, there isn't any point in returning an allocated memory, although other systems won't work properly if this isn't done. The unix implementation thus have to suffer slightly from the drawbacks of other systems. <a name="SEE"></a><h2 class="nroffsh">SEE ALSO</h2>
55 <p class="level0"><span Class="manpage">getenv (3C)</span> <span Class="manpage"> </span> <p class="roffit">
56 This HTML page was made with <a href="http://daniel.haxx.se/projects/roffit/">roffit</a>.
57 </body></html>