summaryrefslogtreecommitdiff
path: root/docs/libcurl/curl_unescape.3
diff options
context:
space:
mode:
Diffstat (limited to 'docs/libcurl/curl_unescape.3')
-rw-r--r--docs/libcurl/curl_unescape.331
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/libcurl/curl_unescape.3 b/docs/libcurl/curl_unescape.3
new file mode 100644
index 00000000..b4e7283c
--- /dev/null
+++ b/docs/libcurl/curl_unescape.3
@@ -0,0 +1,31 @@
+.\" You can view this file with:
+.\" nroff -man [file]
+.\" $Id: curl_unescape.3,v 1.7 2009-05-19 12:48:14 yangtse Exp $
+.\"
+.TH curl_unescape 3 "22 March 2001" "libcurl 7.7" "libcurl Manual"
+.SH NAME
+curl_unescape - URL decodes the given string
+.SH SYNOPSIS
+.B #include <curl/curl.h>
+.sp
+.BI "char *curl_unescape( char *" url ", int "length " );"
+.ad
+.SH DESCRIPTION
+Obsolete function. Use \fIcurl_easy_unescape(3)\fP instead!
+
+This function will convert the given URL encoded input string to a "plain
+string" and return that as a new allocated string. All input characters that
+are URL encoded (%XX where XX is a two-digit hexadecimal number) will be
+converted to their plain text versions.
+
+If the 'length' argument is set to 0, curl_unescape() 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_unescape(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"
+.I curl_easy_escape(3), curl_easy_unescape(3), curl_free(3), RFC 2396