xref: /aosp_15_r20/external/curl/docs/libcurl/curl_unescape.md (revision 6236dae45794135f37c4eb022389c904c8b0090d)
1*6236dae4SAndroid Build Coastguard Worker---
2*6236dae4SAndroid Build Coastguard Workerc: Copyright (C) Daniel Stenberg, <[email protected]>, et al.
3*6236dae4SAndroid Build Coastguard WorkerSPDX-License-Identifier: curl
4*6236dae4SAndroid Build Coastguard WorkerTitle: curl_unescape
5*6236dae4SAndroid Build Coastguard WorkerSection: 3
6*6236dae4SAndroid Build Coastguard WorkerSource: libcurl
7*6236dae4SAndroid Build Coastguard WorkerSee-also:
8*6236dae4SAndroid Build Coastguard Worker  - RFC 2396
9*6236dae4SAndroid Build Coastguard Worker  - curl_easy_escape (3)
10*6236dae4SAndroid Build Coastguard Worker  - curl_easy_unescape (3)
11*6236dae4SAndroid Build Coastguard Worker  - curl_free (3)
12*6236dae4SAndroid Build Coastguard WorkerProtocol:
13*6236dae4SAndroid Build Coastguard Worker  - All
14*6236dae4SAndroid Build Coastguard WorkerAdded-in: 7.1
15*6236dae4SAndroid Build Coastguard Worker---
16*6236dae4SAndroid Build Coastguard Worker
17*6236dae4SAndroid Build Coastguard Worker# NAME
18*6236dae4SAndroid Build Coastguard Worker
19*6236dae4SAndroid Build Coastguard Workercurl_unescape - URL decode a string
20*6236dae4SAndroid Build Coastguard Worker
21*6236dae4SAndroid Build Coastguard Worker# SYNOPSIS
22*6236dae4SAndroid Build Coastguard Worker
23*6236dae4SAndroid Build Coastguard Worker~~~c
24*6236dae4SAndroid Build Coastguard Worker#include <curl/curl.h>
25*6236dae4SAndroid Build Coastguard Worker
26*6236dae4SAndroid Build Coastguard Workerchar *curl_unescape(const char *input, int length);
27*6236dae4SAndroid Build Coastguard Worker~~~
28*6236dae4SAndroid Build Coastguard Worker
29*6236dae4SAndroid Build Coastguard Worker# DESCRIPTION
30*6236dae4SAndroid Build Coastguard Worker
31*6236dae4SAndroid Build Coastguard WorkerDeprecated. Use curl_easy_unescape(3) instead.
32*6236dae4SAndroid Build Coastguard Worker
33*6236dae4SAndroid Build Coastguard WorkerThis function converts the URL encoded string **input** to a "plain string"
34*6236dae4SAndroid Build Coastguard Workerand return that as a new allocated string. All input characters that are URL
35*6236dae4SAndroid Build Coastguard Workerencoded (%XX where XX is a two-digit hexadecimal number) are converted to
36*6236dae4SAndroid Build Coastguard Workertheir plain text versions.
37*6236dae4SAndroid Build Coastguard Worker
38*6236dae4SAndroid Build Coastguard WorkerIf the **length** argument is set to 0, curl_unescape(3) calls
39*6236dae4SAndroid Build Coastguard Workerstrlen() on **input** to find out the size.
40*6236dae4SAndroid Build Coastguard Worker
41*6236dae4SAndroid Build Coastguard WorkerYou must curl_free(3) the returned string when you are done with it.
42*6236dae4SAndroid Build Coastguard Worker
43*6236dae4SAndroid Build Coastguard Worker# %PROTOCOLS%
44*6236dae4SAndroid Build Coastguard Worker
45*6236dae4SAndroid Build Coastguard Worker# EXAMPLE
46*6236dae4SAndroid Build Coastguard Worker
47*6236dae4SAndroid Build Coastguard Worker~~~c
48*6236dae4SAndroid Build Coastguard Workerint main(void)
49*6236dae4SAndroid Build Coastguard Worker{
50*6236dae4SAndroid Build Coastguard Worker  CURL *curl = curl_easy_init();
51*6236dae4SAndroid Build Coastguard Worker  if(curl) {
52*6236dae4SAndroid Build Coastguard Worker    char *decoded = curl_unescape("%63%75%72%6c", 12);
53*6236dae4SAndroid Build Coastguard Worker    if(decoded) {
54*6236dae4SAndroid Build Coastguard Worker      /* do not assume printf() works on the decoded data */
55*6236dae4SAndroid Build Coastguard Worker      printf("Decoded: ");
56*6236dae4SAndroid Build Coastguard Worker      /* ... */
57*6236dae4SAndroid Build Coastguard Worker      curl_free(decoded);
58*6236dae4SAndroid Build Coastguard Worker    }
59*6236dae4SAndroid Build Coastguard Worker  }
60*6236dae4SAndroid Build Coastguard Worker}
61*6236dae4SAndroid Build Coastguard Worker~~~
62*6236dae4SAndroid Build Coastguard Worker
63*6236dae4SAndroid Build Coastguard Worker# DEPRECATED
64*6236dae4SAndroid Build Coastguard Worker
65*6236dae4SAndroid Build Coastguard WorkerSince 7.15.4, curl_easy_unescape(3) should be used. This function might
66*6236dae4SAndroid Build Coastguard Workerbe removed in a future release.
67*6236dae4SAndroid Build Coastguard Worker
68*6236dae4SAndroid Build Coastguard Worker# %AVAILABILITY%
69*6236dae4SAndroid Build Coastguard Worker
70*6236dae4SAndroid Build Coastguard Worker# RETURN VALUE
71*6236dae4SAndroid Build Coastguard Worker
72*6236dae4SAndroid Build Coastguard WorkerA pointer to a null-terminated string or NULL if it failed.
73