curl/docs/libcurl/curl_escape.3

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