1
.\" **************************************************************************
3
.\" * Project ___| | | | _ \| |
4
.\" * / __| | | | |_) | |
5
.\" * | (__| |_| | _ <| |___
6
.\" * \___|\___/|_| \_\_____|
8
.\" * Copyright (C) 1998 - 2006, Daniel Stenberg, <daniel@haxx.se>, et al.
10
.\" * This software is licensed as described in the file COPYING, which
11
.\" * you should have received as part of this distribution. The terms
12
.\" * are also available at http://curl.haxx.se/docs/copyright.html.
14
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15
.\" * copies of the Software, and permit persons to whom the Software is
16
.\" * furnished to do so, under the terms of the COPYING file.
18
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19
.\" * KIND, either express or implied.
21
.\" * $Id: curl_easy_unescape.3,v 1.2 2006-04-08 21:29:01 bagder Exp $
22
.\" **************************************************************************
24
.TH curl_easy_unescape 3 "7 April 2006" "libcurl 7.15.4" "libcurl Manual"
26
curl_easy_unescape - URL decodes the given string
28
.B #include <curl/curl.h>
30
.BI "char *curl_easy_unescape( CURL *" curl ", char *" url ", int "inlength
31
.BI ", int *" outlength " );"
34
This function converts the given URL encoded input string to a "plain string"
35
and returns that in an allocated memory area. All input characters that are
36
URL encoded (%XX where XX is a two-digit hexadecimal number) are converted to
37
their binary versions.
39
If the \fBlength\fP argument is set to 0 (zero), curl_easy_unescape() will use
40
strlen() on the input \fIurl\fP string to find out the size.
42
If \fBoutlength\fP is non-NULL, the function will write the length of the
43
returned string in the integer it points to. This allows an escaped string
44
containing %00 to still get used properly after unescaping.
46
You must \fIcurl_free(3)\fP the returned string when you're done with it.
48
Added in 7.15.4 and replaces the old curl_unescape() function.
50
A pointer to a zero terminated string or NULL if it failed.
52
.I curl_easy_escape(3), curl_free(3), RFC 2396