| .\" ************************************************************************** |
| .\" * _ _ ____ _ |
| .\" * Project ___| | | | _ \| | |
| .\" * / __| | | | |_) | | |
| .\" * | (__| |_| | _ <| |___ |
| .\" * \___|\___/|_| \_\_____| |
| .\" * |
| .\" * Copyright (C) 1998 - 2011, Daniel Stenberg, <daniel@haxx.se>, et al. |
| .\" * |
| .\" * This software is licensed as described in the file COPYING, which |
| .\" * you should have received as part of this distribution. The terms |
| .\" * are also available at http://curl.haxx.se/docs/copyright.html. |
| .\" * |
| .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| .\" * copies of the Software, and permit persons to whom the Software is |
| .\" * furnished to do so, under the terms of the COPYING file. |
| .\" * |
| .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| .\" * KIND, either express or implied. |
| .\" * |
| .\" ************************************************************************** |
| .TH curl_escape 3 "6 March 2002" "libcurl 7.9" "libcurl Manual" |
| .SH NAME |
| curl_escape - URL encodes the given string |
| .SH SYNOPSIS |
| .B #include <curl/curl.h> |
| .sp |
| .BI "char *curl_escape( char *" url ", int "length " );" |
| .ad |
| .SH DESCRIPTION |
| Obsolete function. Use \fIcurl_easy_escape(3)\fP instead! |
| |
| 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, |
| A-Z or 0-9 will be converted to their "URL escaped" version (%NN where NN is a |
| two-digit hexadecimal number). |
| |
| If the 'length' argument is set to 0, curl_escape() will use strlen() on the |
| input 'url' string to find out the size. |
| |
| You must curl_free() the returned string when you're done with it. |
| .SH AVAILABILITY |
| Since 7.15.4, \fIcurl_easy_escape(3)\fP should be used. This function will |
| be removed in a future release. |
| .SH RETURN VALUE |
| A pointer to a zero terminated string or NULL if it failed. |
| .SH "SEE ALSO" |
| .BR curl_unescape "(3), " curl_free "(3), " RFC 2396 |
