mingw/share/man/man3/curl_escape.3

   1 .\" You can view this file with:
   2 .\" nroff -man [file]
   3 .\" $Id: curl_escape.3,v 1.7 2006-04-07 21:50:47 bagder Exp $
   4 .\"
   5 .TH curl_escape 3 "6 March 2002" "libcurl 7.9" "libcurl Manual"
   6 .SH NAME
   7 curl_escape - URL encodes the given string
   8 .SH SYNOPSIS
   9 .B #include <curl/curl.h>
  10 .sp
  11 .BI "char *curl_escape( char *" url ", int "length " );"
  12 .ad
  13 .SH DESCRIPTION
  14 Obsolete function. Use \fIcurl_easy_escape(3)\fP instead!
  15
  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).
  20
  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.
  23
  24 You must curl_free() the returned string when you're done with it.
  25 .SH AVAILABILITY
  26 Since 7.15.4, \fIcurl_easy_escape(3)\fP should be used. This function will
  27 be removed in a future release.
  28 .SH RETURN VALUE
  29 A pointer to a zero terminated string or NULL if it failed.
  30 .SH "SEE ALSO"
  31 .BR curl_unescape "(3), " curl_free "(3), " RFC 2396