blob: 5a82b5aaeac6d9b4ff4d2e53f1d43644f804499c [file] [log] [blame]
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -07001.\" **************************************************************************
2.\" * _ _ ____ _
3.\" * Project ___| | | | _ \| |
4.\" * / __| | | | |_) | |
5.\" * | (__| |_| | _ <| |___
6.\" * \___|\___/|_| \_\_____|
7.\" *
8.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
9.\" *
10.\" * This software is licensed as described in the file COPYING, which
11.\" * you should have received as part of this distribution. The terms
Alex Deymo8f1a2142016-06-28 14:49:26 -070012.\" * are also available at https://curl.haxx.se/docs/copyright.html.
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070013.\" *
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.
17.\" *
18.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19.\" * KIND, either express or implied.
20.\" *
21.\" **************************************************************************
Elliott Hughes1ef06ba2018-05-30 15:43:58 -070022.TH curl_unescape 3 "February 03, 2016" "libcurl 7.60.0" "libcurl Manual"
Elliott Hughes82be86d2017-09-20 17:00:17 -070023
Lucas Eckels9bd90e62012-08-06 15:07:02 -070024.SH NAME
25curl_unescape - URL decodes the given string
26.SH SYNOPSIS
27.B #include <curl/curl.h>
28.sp
Alex Deymo8f1a2142016-06-28 14:49:26 -070029.BI "char *curl_unescape( const char *" url ", int "length " );"
Lucas Eckels9bd90e62012-08-06 15:07:02 -070030.ad
31.SH DESCRIPTION
32Obsolete function. Use \fIcurl_easy_unescape(3)\fP instead!
33
34This function will convert the given URL encoded input string to a "plain
35string" and return that as a new allocated string. All input characters that
36are URL encoded (%XX where XX is a two-digit hexadecimal number) will be
37converted to their plain text versions.
38
39If the 'length' argument is set to 0, curl_unescape() will use strlen() on the
40input 'url' string to find out the size.
41
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070042You must \fIcurl_free(3)\fP the returned string when you're done with it.
Lucas Eckels9bd90e62012-08-06 15:07:02 -070043.SH AVAILABILITY
44Since 7.15.4, \fIcurl_easy_unescape(3)\fP should be used. This function will
45be removed in a future release.
46.SH RETURN VALUE
47A pointer to a zero terminated string or NULL if it failed.
48.SH "SEE ALSO"
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070049.br curl_easy_escape "(3)," curl_easy_unescape "(3)," curl_free "(3)," RFC 2396