aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/curl_easy_unescape.3
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2006-04-07 21:50:47 +0000
committerDaniel Stenberg <daniel@haxx.se>2006-04-07 21:50:47 +0000
commit5a4b43848ac21b3d831f00ce11136e20f820f0a0 (patch)
tree981b8520e1f9aa683da489c8a283fb513dd26f16 /docs/libcurl/curl_easy_unescape.3
parentd98869a0889195a9e0d353cf691219f78186ac93 (diff)
First commit of David McCreedy's EBCDIC and TPF changes.
Diffstat (limited to 'docs/libcurl/curl_easy_unescape.3')
-rw-r--r--docs/libcurl/curl_easy_unescape.348
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/libcurl/curl_easy_unescape.3 b/docs/libcurl/curl_easy_unescape.3
new file mode 100644
index 000000000..6b0e6b5fa
--- /dev/null
+++ b/docs/libcurl/curl_easy_unescape.3
@@ -0,0 +1,48 @@
+.\" **************************************************************************
+.\" * _ _ ____ _
+.\" * Project ___| | | | _ \| |
+.\" * / __| | | | |_) | |
+.\" * | (__| |_| | _ <| |___
+.\" * \___|\___/|_| \_\_____|
+.\" *
+.\" * Copyright (C) 1998 - 2006, 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.
+.\" *
+.\" * $Id$
+.\" **************************************************************************
+.\"
+.TH curl_easy_unescape 3 "7 April 2006" "libcurl 7.15.4" "libcurl Manual"
+.SH NAME
+curl_easy_unescape - URL decodes the given string
+.SH SYNOPSIS
+.B #include <curl/curl.h>
+.sp
+.BI "char *curl_easy_unescape( CURL *" curl ", char *" url ", int "inlength
+.BI ", int *" outlength " );"
+.ad
+.SH DESCRIPTION
+This function converts the given URL encoded input string to a "plain string"
+and returns that in an allocated memory area. All input characters that are
+URL encoded (%XX where XX is a two-digit hexadecimal number) are converted to
+their binary versions.
+
+If the \fBlength\fP argument is set to 0 (zero), curl_easy_unescape() will use
+strlen() on the input \fIurl\fP string to find out the size.
+
+You must \fIcurl_free(3)\fP the returned string when you're done with it.
+.SH AVAILABILITY
+Added in 7.15.4 and replaces the old curl_unescape() function.
+.SH RETURN VALUE
+A pointer to a zero terminated string or NULL if it failed.
+.SH "SEE ALSO"
+.I curl_easy_escape(3), curl_free(3), RFC 2396