moparisthebest/curl
1
0
Fork 0
mirror of https://github.com/moparisthebest/curl synced 2024-11-14 21:45:13 -05:00
Code Issues Releases Wiki Activity

curl_getenv.3: Fix the memory handling description

Browse Source 
- Tell the user to call curl_free() to free the pointer returned by
  curl_getenv().

Prior to this change the user was directed to call free(), but that
would not work in cases where the library and application use separate C
runtimes and therefore have separate heap memory management.

Closes https://github.com/curl/curl/pull/5016
This commit is contained in:
Jay Satiro 2020-03-02 02:59:40 -05:00
parent 0b337ecc91
commit 1722eb83b4
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/libcurl/curl_getenv.3
View File

@ -31,15 +31,15 @@ curl_getenv - return value for environment name
curl_getenv() is a portable wrapper for the getenv() function, meant to curl_getenv() is a portable wrapper for the getenv() function, meant to
emulate its behaviour and provide an identical interface for all operating emulate its behaviour and provide an identical interface for all operating
systems libcurl builds on (including win32). systems libcurl builds on (including win32).
You must \fIcurl_free(3)\fP the returned string when you're done with it.
.SH AVAILABILITY .SH AVAILABILITY
This function will be removed from the public libcurl API in a near future. It 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 will instead be made "available" by source code access only, and then as
curlx_getenv(). curlx_getenv().
.SH RETURN VALUE .SH RETURN VALUE
If successful, curl_getenv() returns a pointer to the value of the specified A pointer to a zero terminated string or NULL if it failed to find the
environment. The memory it refers to is malloc()ed so the application must specified name.
free() this when the data is no longer needed. When \fIcurl_getenv(3)\fP fails
to find the specified name, it returns a null pointer.
.SH NOTE .SH NOTE
Under unix operating systems, there isn't any point in returning an allocated 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 memory, although other systems won't work properly if this isn't done. The