Walter J. Mack's curl_free addition

This commit is contained in:
Daniel Stenberg 2002-09-25 12:11:12 +00:00
parent ec9acbcda7
commit 24e7036822
3 changed files with 70 additions and 53 deletions

View File

@ -1,26 +1,26 @@
.\" You can view this file with: .\" You can view this file with:
.\" nroff -man [file] .\" nroff -man [file]
.\" $Id$ .\" $Id$
.\" .\"
.TH curl_escape 3 "6 March 2002" "libcurl 7.9" "libcurl Manual" .TH curl_escape 3 "6 March 2002" "libcurl 7.9" "libcurl Manual"
.SH NAME .SH NAME
curl_escape - URL encodes the given string curl_escape - URL encodes the given string
.SH SYNOPSIS .SH SYNOPSIS
.B #include <curl/curl.h> .B #include <curl/curl.h>
.sp .sp
.BI "char *curl_escape( char *" url ", int "length " );" .BI "char *curl_escape( char *" url ", int "length " );"
.ad .ad
.SH DESCRIPTION .SH DESCRIPTION
This function will convert the given input string to an URL encoded string and This function will convert the given input string to an URL encoded string and
return that as a new allocated string. All input characters that are not a-z, return that as a new allocated string. All input characters that are not a-z,
A-Z or 0-9 will be converted to their "URL escaped" version (%NN where NN is a A-Z or 0-9 will be converted to their "URL escaped" version (%NN where NN is a
two-digit hexadecimal number). two-digit hexadecimal number).
If the 'length' argument is set to 0, curl_escape() will use strlen() on the If the 'length' argument is set to 0, curl_escape() will use strlen() on the
input 'url' string to find out the size. input 'url' string to find out the size.
You must free() the returned string when you're done with it. You must curl_free() the returned string when you're done with it.
.SH RETURN VALUE .SH RETURN VALUE
A pointer to a zero terminated string or NULL if it failed. A pointer to a zero terminated string or NULL if it failed.
.SH "SEE ALSO" .SH "SEE ALSO"
.I curl_unescape(), RFC 2396 .I curl_unescape(), curl_free(), RFC 2396

17
docs/libcurl/curl_free.3 Normal file
View File

@ -0,0 +1,17 @@
.\" You can view this file with:
.\" nroff -man [file]
.\" $Id:
.\"
.TH curl_free 3 "24 Sept 2002" "libcurl 7.10" "libcurl Manual"
.SH NAME
curl_free - reclaim memory that has been obtained through a libcurl call
.SH SYNOPSIS
.B #include <curl/curl.h>
.sp
.BI "void *curl_free( char *" ptr " );"
.ad
.SH DESCRIPTION
curl_free reclaims memory that has been obtained through a libcurl call.
Use curl_free() instead of free() to avoid anomalies that can result from differences in memory management between your application and libcurl.
.SH "SEE ALSO"
.I curl_unescape(), curl_free()

View File

@ -1,27 +1,27 @@
.\" You can view this file with: .\" You can view this file with:
.\" nroff -man [file] .\" nroff -man [file]
.\" $Id$ .\" $Id$
.\" .\"
.TH curl_unescape 3 "22 March 2001" "libcurl 7.7" "libcurl Manual" .TH curl_unescape 3 "22 March 2001" "libcurl 7.7" "libcurl Manual"
.SH NAME .SH NAME
curl_unescape - URL decodes the given string curl_unescape - URL decodes the given string
.SH SYNOPSIS .SH SYNOPSIS
.B #include <curl/curl.h> .B #include <curl/curl.h>
.sp .sp
.BI "char *curl_unescape( char *" url ", int "length " );" .BI "char *curl_unescape( char *" url ", int "length " );"
.ad .ad
.SH DESCRIPTION .SH DESCRIPTION
This function will convert the given URL encoded input string to a "plain This function will convert the given URL encoded input string to a "plain
string" and return that as a new allocated string. All input characters that string" and return that as a new allocated string. All input characters that
are URL encoded (%XX where XX is a two-digit hexadecimal number, or +) will be are URL encoded (%XX where XX is a two-digit hexadecimal number, or +) will be
converted to their plain text versions (up to a ? letter, no + letters to the converted to their plain text versions (up to a ? letter, no + letters to the
right of a ? letter will be converted). right of a ? letter will be converted).
If the 'length' argument is set to 0, curl_unescape() will use strlen() on the If the 'length' argument is set to 0, curl_unescape() will use strlen() on the
input 'url' string to find out the size. input 'url' string to find out the size.
You must free() the returned string when you're done with it. You must curl_free() the returned string when you're done with it.
.SH RETURN VALUE .SH RETURN VALUE
A pointer to a zero terminated string or NULL if it failed. A pointer to a zero terminated string or NULL if it failed.
.SH "SEE ALSO" .SH "SEE ALSO"
.I curl_escape(), RFC 2396 .I curl_escape(), curl_free(), RFC 2396