diff options
author | Daniel Stenberg <daniel@haxx.se> | 2000-06-02 11:01:08 +0000 |
---|---|---|
committer | Daniel Stenberg <daniel@haxx.se> | 2000-06-02 11:01:08 +0000 |
commit | 52195a0547b5b91533f2f77478485ce27d50319d (patch) | |
tree | 8a134e35526494e04b693e8596d8bf64aced62c7 /docs | |
parent | e5ba9f058f2186a63cf2d070295f92abb5e83b62 (diff) |
Added description
Diffstat (limited to 'docs')
-rw-r--r-- | docs/curl_getenv.3 | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/curl_getenv.3 b/docs/curl_getenv.3 index e69de29bb..f1d57664d 100644 --- a/docs/curl_getenv.3 +++ b/docs/curl_getenv.3 @@ -0,0 +1,32 @@ +.\" You can view this file with: +.\" nroff -man [file] +.\" Written by Daniel.Stenberg@haxx.nu +.\" +.TH curl_getenv 3 "2 June 2000" "Curl 7.0" "libcurl Manual" +.SH NAME +curl_getenv - return value for environment name +.SH SYNOPSIS +.B #include <curl/curl.h> +.sp +.BI "char *curl_getenv(char *" name "); +.ad +.SH DESCRIPTION +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). +.SH RETURN VALUE +If successful, curl_getenv() returns a pointer to the value of the specified +environment. The memory it refers to is malloc()ed why the application must +free() this when the data has completed to serve its purpose. When +.I curl_getenv() +fails to find the specified name, it returns a null pointer. +.SH NOTE +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. +.SH "SEE ALSO" +.BR getenv "(3C), " +.SH BUGS +Surely there are some, you tell me! + |