1 .\" You can view this file with:
3 .\" $Id: curl_escape.3,v 1.1.1.1 2008-09-23 16:32:05 hoffman Exp $
5 .TH curl_escape 3 "6 March 2002" "libcurl 7.9" "libcurl Manual"
7 curl_escape - URL encodes the given string
9 .B #include <curl/curl.h>
11 .BI "char *curl_escape( char *" url ", int "length " );"
14 Obsolete function. Use \fIcurl_easy_escape(3)\fP instead!
16 This function will convert the given input string to an URL encoded string and
17 return that as a new allocated string. All input characters that are not a-z,
18 A-Z or 0-9 will be converted to their "URL escaped" version (%NN where NN is a
19 two-digit hexadecimal number).
21 If the 'length' argument is set to 0, curl_escape() will use strlen() on the
22 input 'url' string to find out the size.
24 You must curl_free() the returned string when you're done with it.
26 Since 7.15.4, \fIcurl_easy_escape(3)\fP should be used. This function will
27 be removed in a future release.
29 A pointer to a zero terminated string or NULL if it failed.
31 .BR curl_unescape "(3), " curl_free "(3), " RFC 2396