| 9487f7f | 2011-08-03 07:05:30 -0700 | [diff] [blame] | 1 | .\" You can view this file with: |
| 2 | .\" nroff -man [file] |
| 3 | .\" |
| 4 | .TH curl_escape 3 "6 March 2002" "libcurl 7.9" "libcurl Manual" |
| 5 | .SH NAME |
| 6 | curl_escape - URL encodes the given string |
| 7 | .SH SYNOPSIS |
| 8 | .B #include <curl/curl.h> |
| 9 | .sp |
| 10 | .BI "char *curl_escape( char *" url ", int "length " );" |
| 11 | .ad |
| 12 | .SH DESCRIPTION |
| 13 | Obsolete function. Use \fIcurl_easy_escape(3)\fP instead! |
| 14 | |
| 15 | This function will convert the given input string to an URL encoded string and |
| 16 | return that as a new allocated string. All input characters that are not a-z, |
| 17 | A-Z or 0-9 will be converted to their "URL escaped" version (%NN where NN is a |
| 18 | two-digit hexadecimal number). |
| 19 | |
| 20 | If the 'length' argument is set to 0, curl_escape() will use strlen() on the |
| 21 | input 'url' string to find out the size. |
| 22 | |
| 23 | You must curl_free() the returned string when you're done with it. |
| 24 | .SH AVAILABILITY |
| 25 | Since 7.15.4, \fIcurl_easy_escape(3)\fP should be used. This function will |
| 26 | be removed in a future release. |
| 27 | .SH RETURN VALUE |
| 28 | A pointer to a zero terminated string or NULL if it failed. |
| 29 | .SH "SEE ALSO" |
| 30 | .BR curl_unescape "(3), " curl_free "(3), " RFC 2396 |