Resync
[CMakeLuaTailorHgBridge.git] / CMakeLua / Utilities / cmcurl-7.19.0 / docs / libcurl / curl_unescape.3
blobadc4f6133c6b69678324fd8807385e0e7a9fbeda
1 .\" You can view this file with:
2 .\" nroff -man [file]
3 .\" $Id: curl_unescape.3,v 1.1.1.1 2008-09-23 16:32:05 hoffman Exp $
4 .\"
5 .TH curl_unescape 3 "22 March 2001" "libcurl 7.7" "libcurl Manual"
6 .SH NAME
7 curl_unescape - URL decodes the given string
8 .SH SYNOPSIS
9 .B #include <curl/curl.h>
10 .sp
11 .BI "char *curl_unescape( char *" url ", int "length " );"
12 .ad
13 .SH DESCRIPTION
14 Obsolete function. Use \fIcurl_easy_unescape(3)\fP instead!
16 This function will convert the given URL encoded input string to a "plain
17 string" and return that as a new allocated string. All input characters that
18 are URL encoded (%XX where XX is a two-digit hexadecimal number) will be
19 converted to their plain text versions.
21 If the 'length' argument is set to 0, curl_unescape() 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.
25 .SH AVAILABILITY
26 Since 7.15.4, \fIcurl_easy_unescape(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 .I curl_easy_escape(3), curl_easy_unescape(3), curl_free(3), RFC 2396